diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index b226683623..b73b7de69a 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -75736,6 +75736,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. Read-only. @@ -75855,6 +75857,10 @@ declare namespace OneNote { select?: string; expand?: string; }): OneNote.Application; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ApplicationData; } /** @@ -75864,6 +75870,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysis extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the parent page object. Read-only. @@ -75921,6 +75929,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysis; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysis object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisData; } /** @@ -75930,6 +75942,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisParagraph extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisPage. Read-only. @@ -75994,6 +76008,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisParagraph; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisParagraph object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphData; } /** @@ -76003,6 +76021,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisParagraphCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisParagraph[]; /** @@ -76056,6 +76076,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisParagraphCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData; } /** @@ -76065,6 +76089,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisLine extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisParagraph. Read-only. @@ -76129,6 +76155,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisLine; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisLine object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineData; } /** @@ -76138,6 +76168,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisLineCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisLine[]; /** @@ -76191,6 +76223,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisLineCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisLineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData; } /** @@ -76200,6 +76236,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisWord extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisLine. Read-only. @@ -76278,6 +76316,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisWord; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisWord object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordData; } /** @@ -76287,6 +76329,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisWordCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisWord[]; /** @@ -76340,6 +76384,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisWordCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData; } /** @@ -76349,6 +76397,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class FloatingInk extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the strokes of the FloatingInk object. Read-only. @@ -76399,6 +76449,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.FloatingInk; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.FloatingInk object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.FloatingInkData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.FloatingInkData; } /** @@ -76408,6 +76462,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkStroke extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the ID of the InkStroke object. Read-only. @@ -76451,6 +76507,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkStroke; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkStroke object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkStrokeData; } /** @@ -76460,6 +76520,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkStrokeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkStroke[]; /** @@ -76513,6 +76575,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkStrokeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkStrokeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkStrokeCollectionData; } /** @@ -76522,6 +76588,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkWord extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The parent paragraph containing the ink word. Read-only. @@ -76579,6 +76647,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkWord; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkWord object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkWordData; } /** @@ -76588,6 +76660,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkWordCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkWord[]; /** @@ -76641,6 +76715,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkWordCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkWordCollectionData; } /** @@ -76650,6 +76728,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Notebook extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The section groups in the notebook. Read only @@ -76753,6 +76833,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Notebook; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Notebook object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.NotebookData; } /** @@ -76762,6 +76846,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class NotebookCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Notebook[]; /** @@ -76824,6 +76910,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.NotebookCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.NotebookCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.NotebookCollectionData; } /** @@ -76833,6 +76923,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the notebook that contains the section group. Read-only. @@ -76943,6 +77035,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionGroup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.SectionGroup object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.SectionGroupData; } /** @@ -76952,6 +77048,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionGroupCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.SectionGroup[]; /** @@ -77014,6 +77112,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionGroupCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.SectionGroupCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.SectionGroupCollectionData; } /** @@ -77023,6 +77125,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Section extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the notebook that contains the section. Read-only. @@ -77176,6 +77280,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Section; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Section object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.SectionData; } /** @@ -77185,6 +77293,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Section[]; /** @@ -77247,6 +77357,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.SectionCollectionData; } /** @@ -77256,6 +77370,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Page extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The collection of PageContent objects on the page. Read only @@ -77439,6 +77555,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Page; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Page object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.PageData; } /** @@ -77448,6 +77568,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Page[]; /** @@ -77510,6 +77632,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.PageCollectionData; } /** @@ -77519,6 +77645,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageContent extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. @@ -77625,6 +77753,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageContent; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.PageContent object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.PageContentData; } /** @@ -77634,6 +77766,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageContentCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.PageContent[]; /** @@ -77687,6 +77821,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageContentCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.PageContentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.PageContentCollectionData; } /** @@ -77696,6 +77834,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Outline extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. @@ -77793,6 +77933,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Outline; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Outline object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.OutlineData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.OutlineData; } /** @@ -77802,6 +77946,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Paragraph extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. @@ -78051,6 +78197,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Paragraph; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Paragraph object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ParagraphData; } /** @@ -78060,6 +78210,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class ParagraphCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Paragraph[]; /** @@ -78113,6 +78265,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.ParagraphCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.ParagraphCollectionData; } /** @@ -78122,6 +78278,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class NoteTag extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Id of the NoteTag object. Read-only. @@ -78172,6 +78330,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.NoteTag; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.NoteTag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NoteTagData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.NoteTagData; } /** @@ -78181,6 +78343,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class RichText extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Paragraph object that contains the RichText object. Read-only. @@ -78246,6 +78410,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.RichText; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.RichText object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.RichTextData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.RichTextData; } /** @@ -78255,6 +78423,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Image extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. Read-only. @@ -78362,6 +78532,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Image; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Image object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ImageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ImageData; } /** @@ -78371,6 +78545,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Paragraph object that contains the Table object. Read-only. @@ -78519,6 +78695,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Table; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Table object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableData; } /** @@ -78528,6 +78708,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the cells in the row. Read-only. @@ -78627,6 +78809,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableRow; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.TableRow object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableRowData; } /** @@ -78636,6 +78822,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableRow[]; /** @@ -78689,6 +78877,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableRowCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.TableRowCollectionData; } /** @@ -78698,6 +78890,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableCell extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of Paragraph objects in the TableCell. Read-only. @@ -78830,6 +79024,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableCell; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.TableCell object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableCellData; } /** @@ -78839,6 +79037,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableCell[]; /** @@ -78892,6 +79092,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableCellCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.TableCellCollectionData; } /** @@ -79352,13 +79556,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ page?: OneNote.Interfaces.PageData; - /** - * - * Gets the ink analysis paragraphs in this page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraphs?: OneNote.Interfaces.InkAnalysisParagraphData[]; /** * * Gets the ID of the InkAnalysis object. Read-only. @@ -79474,13 +79671,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ inkStrokes?: OneNote.Interfaces.InkStrokeData[]; - /** - * - * Gets the PageContent parent of the FloatingInk object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; /** * * Gets the ID of the FloatingInk object. Read-only. @@ -79512,13 +79702,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "inkWord.toJSON()". */ interface InkWordData { - /** - * - * The parent paragraph containing the ink word. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets the ID of the InkWord object. Read-only. @@ -79603,27 +79786,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "sectionGroup.toJSON()". */ interface SectionGroupData { - /** - * - * Gets the notebook that contains the section group. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - notebook?: OneNote.Interfaces.NotebookData; - /** - * - * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroup?: OneNote.Interfaces.SectionGroupData; - /** - * - * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupData; /** * * The collection of section groups in the section group. Read only @@ -79666,13 +79828,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "section.toJSON()". */ interface SectionData { - /** - * - * Gets the notebook that contains the section. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - notebook?: OneNote.Interfaces.NotebookData; /** * * The collection of pages in the section. Read only @@ -79680,20 +79835,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ pages?: OneNote.Interfaces.PageData[]; - /** - * - * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroup?: OneNote.Interfaces.SectionGroupData; - /** - * - * Gets the section group that contains the section. Returns null if the section is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupData; /** * * The client url of the section. Read only @@ -79757,13 +79898,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisData; - /** - * - * Gets the section that contains the page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSection?: OneNote.Interfaces.SectionData; /** * * Gets the ClassNotebookPageSource to the page. @@ -79834,13 +79968,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ outline?: OneNote.Interfaces.OutlineData; - /** - * - * Gets the page that contains the PageContent object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentPage?: OneNote.Interfaces.PageData; /** * * Gets the ID of the PageContent object. Read-only. @@ -79876,13 +80003,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "outline.toJSON()". */ interface OutlineData { - /** - * - * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; /** * * Gets the collection of Paragraph objects in the Outline. Read-only. @@ -79916,13 +80036,6 @@ declare namespace OneNote { inkWords?: OneNote.Interfaces.InkWordData[]; /** * - * Gets the Outline object that contains the Paragraph. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - outline?: OneNote.Interfaces.OutlineData; - /** - * * The collection of paragraphs under this paragraph. Read only * * [Api set: OneNoteApi 1.1] @@ -79930,34 +80043,6 @@ declare namespace OneNote { paragraphs?: OneNote.Interfaces.ParagraphData[]; /** * - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentParagraph?: OneNote.Interfaces.ParagraphData; - /** - * - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentParagraphOrNull?: OneNote.Interfaces.ParagraphData; - /** - * - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTableCell?: OneNote.Interfaces.TableCellData; - /** - * - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTableCellOrNull?: OneNote.Interfaces.TableCellData; - /** - * * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. Read-only * * [Api set: OneNoteApi 1.1] @@ -80015,13 +80100,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "richText.toJSON()". */ interface RichTextData { - /** - * - * Gets the Paragraph object that contains the RichText object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets the ID of the RichText object. Read-only. @@ -80046,20 +80124,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "image.toJSON()". */ interface ImageData { - /** - * - * 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. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; - /** - * - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets or sets the description of the Image. @@ -80105,13 +80169,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "table.toJSON()". */ interface TableData { - /** - * - * Gets the Paragraph object that contains the Table object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets all of the table rows. Read-only. @@ -80157,13 +80214,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ cells?: OneNote.Interfaces.TableCellData[]; - /** - * - * Gets the parent table. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTable?: OneNote.Interfaces.TableData; /** * * Gets the number of cells in the row. Read-only. @@ -80199,13 +80249,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphData[]; - /** - * - * Gets the parent row of the cell. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentRow?: OneNote.Interfaces.TableRowData; /** * * Gets the index of the cell in its row. Read-only. @@ -80239,7 +80282,6 @@ declare namespace OneNote { interface TableCellCollectionData { items?: OneNote.Interfaces.TableCellData[]; } - /** * * Represents the top-level object that contains all globally addressable OneNote objects such as notebooks, the active notebook, and the active section. @@ -80271,13 +80313,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ page?: OneNote.Interfaces.PageLoadOptions; - /** - * - * Gets the ink analysis paragraphs in this page. - * - * [Api set: OneNoteApi 1.1] - */ - paragraphs?: OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions; /** * * Gets the ID of the InkAnalysis object. Read-only. @@ -81923,25 +81958,18 @@ declare namespace OneNote { * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the OneNote application. Since the Office add-in and the OneNote application run in two different processes, the request context is required to get access to the OneNote object model from the add-in. */ function run(batch: (context: OneNote.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the OneNote object model, using the request context of a previously-created API object. + * @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + */ + function run(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the OneNote object model, using the request context of previously-created API objects. * @param object - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared request context, which means that any changes applied to these objects will be picked up by "context.sync()". * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. */ function run(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise): Promise; - /** - * Executes a batch script that performs actions on the OneNote object model, using the request context of a previously-created API object. - * @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". - * @param batch - A function that takes in an OneNote.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. - * - * @remarks - * In addition to this signature, the method also has the following signatures: - * - * `run(batch: (context: OneNote.RequestContext) => Promise): Promise;` - * - * `run(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise): Promise;` - */ - function run(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise): Promise; } @@ -82114,6 +82142,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Show or hide the iFrame application borders. @@ -82192,6 +82222,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Document extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Represents a Visio application instance that contains this document. Read-only. @@ -82334,6 +82366,8 @@ declare namespace Visio { * [Api set: 1.1] */ class DocumentView extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Disable Hyperlinks. @@ -82348,6 +82382,13 @@ declare namespace Visio { * [Api set: 1.1] */ disablePan: boolean; + /** + * + * Disable PanZoomWindow. + * + * [Api set: 1.1] + */ + disablePanZoomWindow: boolean; /** * * Disable Zoom. @@ -82406,6 +82447,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Page extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * All shapes in the Page, including subshapes. Read-only. @@ -82520,6 +82563,8 @@ declare namespace Visio { * [Api set: 1.1] */ class PageView extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom. @@ -82619,6 +82664,8 @@ declare namespace Visio { * [Api set: 1.1] */ class PageCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Visio.Page[]; /** @@ -82664,6 +82711,8 @@ declare namespace Visio { * [Api set: 1.1] */ class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Visio.Shape[]; /** @@ -82709,6 +82758,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Returns the Comments Collection. Read-only. @@ -82823,6 +82874,8 @@ declare namespace Visio { * [Api set: 1.1] */ class ShapeView extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Represents the highlight around the shape. @@ -82871,7 +82924,7 @@ declare namespace Visio { * @param Width Overlay Width. * @param Height Overlay Height. */ - addOverlay(OverlayType: "Text" | "Image", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult; + addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult; /** * * Removes particular overlay or all overlays on the Shape. @@ -82991,6 +83044,8 @@ declare namespace Visio { * [Api set: 1.1] */ class ShapeDataItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Visio.ShapeDataItem[]; /** @@ -83036,6 +83091,8 @@ declare namespace Visio { * [Api set: 1.1] */ class ShapeDataItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * A string that specifies the format of the shape data item. Read-only. @@ -83094,6 +83151,8 @@ declare namespace Visio { * [Api set: 1.1] */ class HyperlinkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Visio.Hyperlink[]; /** @@ -83139,6 +83198,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Hyperlink extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the address of the Hyperlink object. Read-only. @@ -83197,6 +83258,8 @@ declare namespace Visio { * [Api set: 1.1] */ class CommentCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Visio.Comment[]; /** @@ -83242,6 +83305,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Comment extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * A string that specifies the name of the author of the comment. @@ -83307,6 +83372,8 @@ declare namespace Visio { * [Api set: 1.1] */ class Selection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Shapes of the Selection. Read-only. @@ -83407,6 +83474,12 @@ declare namespace Visio { * */ image = "Image", + /** + * + * html + * + */ + html = "Html", } /** * @@ -83506,6 +83579,13 @@ declare namespace Visio { * [Api set: 1.1] */ disablePan?: boolean; + /** + * + * Disable PanZoomWindow. + * + * [Api set: 1.1] + */ + disablePanZoomWindow?: boolean; /** * * Disable Zoom. @@ -83669,6 +83749,13 @@ declare namespace Visio { * [Api set: 1.1] */ disablePan?: boolean; + /** + * + * Disable PanZoomWindow. + * + * [Api set: 1.1] + */ + disablePanZoomWindow?: boolean; /** * * Disable Zoom. @@ -84020,6 +84107,13 @@ declare namespace Visio { * [Api set: 1.1] */ disablePan?: boolean; + /** + * + * Disable PanZoomWindow. + * + * [Api set: 1.1] + */ + disablePanZoomWindow?: boolean; /** * * Disable Zoom. @@ -84476,9 +84570,9 @@ declare namespace Visio { readonly document: Document; } /** - * Executes a batch script that performs actions on the Visio object model, using a new request context. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. - * @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the request context is required to get access to the Visio object model from the add-in. - */ + * Executes a batch script that performs actions on the Visio object model, using a new request context. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param batch - A function that takes in an Visio.RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the request context is required to get access to the Visio object model from the add-in. + */ function run(batch: (context: Visio.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the Visio object model, using the request context of a previously-created API object. @@ -84496,14 +84590,13 @@ declare namespace Visio { * Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. * @param contextObject - A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context. * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in. - * * @remarks * In addition to this signature, the method also has the following signatures: - * + * * `run(batch: (context: Visio.RequestContext) => Promise): Promise;` - * + * * `run(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise): Promise;` - * + * * `run(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise): Promise;` */ function run(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise): Promise; diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 0905a9ab54..8c918cc8e2 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -49638,6 +49638,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Creates a new document by using an optional base64 encoded .docx file. @@ -49662,6 +49664,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Body extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of rich text content control objects in the body. Read-only. @@ -49797,7 +49801,7 @@ declare namespace Word { clear(): void; /** * - * Gets the HTML representation of the body object. + * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word Online, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -50072,6 +50076,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class ContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of content control objects in the content control. Read-only. @@ -50200,7 +50206,7 @@ declare namespace Word { readonly id: number; /** * - * Gets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * [Api set: WordApi 1.1] */ @@ -50293,7 +50299,7 @@ declare namespace Word { delete(keepContent: boolean): void; /** * - * Gets the HTML representation of the content control object. + * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word Online, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -50435,7 +50441,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method is only supported if the content control encompasses one or more paragraphs in entirety. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. * * [Api set: WordApi 1.1] * @@ -50445,7 +50451,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. This method is only supported if the content control encompasses one or more paragraphs in entirety. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Start', 'End', 'Before', or 'After'. * * [Api set: WordApi 1.1] * @@ -50583,6 +50589,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class ContentControlCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.ContentControl[]; /** @@ -50688,6 +50696,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class CustomProperty extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the key of the custom property. Read only. @@ -50768,6 +50778,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class CustomPropertyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.CustomProperty[]; /** @@ -50847,6 +50859,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Document extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. @@ -50948,6 +50962,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class DocumentCreated extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. @@ -51049,6 +51065,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class DocumentProperties extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of custom properties of the document. Read only. @@ -51227,6 +51245,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Font extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. @@ -51356,6 +51376,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class InlinePicture extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the parent paragraph that contains the inline image. Read-only. @@ -51509,7 +51531,7 @@ declare namespace Word { getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51519,7 +51541,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51536,7 +51558,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a document at the specified location. + * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51546,7 +51568,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts a document at the specified location. + * Inserts a document at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51556,7 +51578,7 @@ declare namespace Word { insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts HTML at the specified location. + * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51566,7 +51588,7 @@ declare namespace Word { insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts HTML at the specified location. + * Inserts HTML at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51596,7 +51618,7 @@ declare namespace Word { insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture; /** * - * Inserts OOXML at the specified location. + * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51606,7 +51628,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts OOXML at the specified location. + * Inserts OOXML at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51616,7 +51638,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51626,7 +51648,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51636,7 +51658,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts text at the specified location. + * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51646,7 +51668,7 @@ declare namespace Word { insertText(text: string, insertLocation: Word.InsertLocation): Word.Range; /** * - * Inserts text at the specified location. + * Inserts text at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.2] * @@ -51710,6 +51732,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class InlinePictureCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.InlinePicture[]; /** @@ -51761,6 +51785,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class List extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets paragraphs in the list. Read-only. @@ -51952,6 +51978,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class ListCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.List[]; /** @@ -52030,6 +52058,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class ListItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets or sets the level of the item in the list. @@ -52130,6 +52160,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Paragraph extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of content control objects in the paragraph. Read-only. @@ -52387,7 +52419,7 @@ declare namespace Word { detachFromList(): void; /** * - * Gets the HTML representation of the paragraph object. + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word Online, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -52457,7 +52489,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -52467,7 +52499,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -52564,7 +52596,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -52574,7 +52606,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -52584,7 +52616,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -52596,7 +52628,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -52718,6 +52750,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class ParagraphCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Paragraph[]; /** @@ -52783,6 +52817,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Range extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of content control objects in the range. Read-only. @@ -52966,7 +53002,7 @@ declare namespace Word { expandToOrNullObject(range: Word.Range): Word.Range; /** * - * Gets the HTML representation of the range object. + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word Online, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * [Api set: WordApi 1.1] */ @@ -53035,7 +53071,7 @@ declare namespace Word { getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -53045,7 +53081,7 @@ declare namespace Word { insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void; /** * - * Inserts a break at the specified location in the main document. + * Inserts a break at the specified location in the main document. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -53142,7 +53178,7 @@ declare namespace Word { insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -53152,7 +53188,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.1] * @@ -53162,7 +53198,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -53174,7 +53210,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -53308,6 +53344,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class RangeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Range[]; /** @@ -53359,6 +53397,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class SearchOptions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; matchWildCards: boolean; /** * @@ -53457,6 +53497,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class Section extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the body object of the section. This does not include the header/footer and other section metadata. Read-only. @@ -53566,6 +53608,8 @@ declare namespace Word { * [Api set: WordApi 1.1] */ class SectionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Section[]; /** @@ -53617,6 +53661,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. @@ -54037,7 +54083,7 @@ declare namespace Word { insertContentControl(): Word.ContentControl; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -54047,7 +54093,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph; /** * - * Inserts a paragraph at the specified location. + * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -54057,7 +54103,7 @@ declare namespace Word { insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -54069,7 +54115,7 @@ declare namespace Word { insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table; /** * - * Inserts a table with the specified number of rows and columns. + * Inserts a table with the specified number of rows and columns. The insertLocation value can be 'Before' or 'After'. * * [Api set: WordApi 1.3] * @@ -54173,6 +54219,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Table[]; /** @@ -54224,6 +54272,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets cells. Read-only. @@ -54495,6 +54545,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.TableRow[]; /** @@ -54546,6 +54598,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableCell extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the body object of the cell. Read-only. @@ -54803,6 +54857,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.TableCell[]; /** @@ -54854,6 +54910,8 @@ declare namespace Word { * [Api set: WordApi 1.3] */ class TableBorder extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets or sets the table border color. @@ -54920,6 +54978,38 @@ declare namespace Word { untrack(): Word.TableBorder; toJSON(): Word.Interfaces.TableBorderData; } + /** + * + * Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added. + * + * [Api set: WordApi] + */ + enum EventType { + /** + * + * ContentControlDeleted represent the event that the content control has been deleted. + * + */ + contentControlDeleted = "ContentControlDeleted", + /** + * + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. + * + */ + contentControlSelectionChanged = "ContentControlSelectionChanged", + /** + * + * ContentControlDataChanged represents the event that the data in the content control have been changed. + * + */ + contentControlDataChanged = "ContentControlDataChanged", + /** + * + * ContentControlAdded represents the event a content control has been added to the document. + * + */ + contentControlAdded = "ContentControlAdded", + } /** * * Specifies supported content control types and subtypes. @@ -55885,13 +55975,6 @@ declare namespace Word { * [Api set: WordApi 1.3] */ properties?: Word.Interfaces.DocumentPropertiesUpdateData; - /** - * - * Gets or sets a value that indicates that, when opening a new document, whether it is allowed to close this document even if this document is untitled. True to close, false otherwise. - * - * [Api set: WordApi] - */ - allowCloseOnUntitled?: boolean; } /** An interface for updating data on the DocumentCreated object, for use in "documentCreated.set({ ... })". */ interface DocumentCreatedUpdateData { @@ -56935,13 +57018,6 @@ declare namespace Word { * [Api set: WordApi 1.1] */ sections?: Word.Interfaces.SectionData[]; - /** - * - * Gets or sets a value that indicates that, when opening a new document, whether it is allowed to close this document even if this document is untitled. True to close, false otherwise. - * - * [Api set: WordApi] - */ - allowCloseOnUntitled?: boolean; /** * * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only. @@ -60641,22 +60717,30 @@ declare namespace Word { readonly application: Application; } /** - * Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects. + * @param objects - An array of previously created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()". * @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 Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. */ - function run(batch: (context: Word.RequestContext) => Promise): Promise; + function run(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise): Promise; /** - * Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. - * @param object - A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param object - A previously created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. */ function run(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise): Promise; /** - * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously-created API objects. - * @param objects - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()". + * Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. * @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 Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. + * + * @remarks + * + * In addition to this signature, the method also has the following signatures, which allow you to resume using the request context of previously created objects: + * + * run(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise): Promise; + * + * run(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise): Promise; */ - function run(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise): Promise; + function run(batch: (context: Word.RequestContext) => Promise): Promise; } @@ -60684,6 +60768,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of notebooks that are open in the OneNote application instance. In OneNote Online, only one notebook at a time is open in the application instance. Read-only. @@ -60803,6 +60889,10 @@ declare namespace OneNote { select?: string; expand?: string; }): OneNote.Application; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ApplicationData; } /** @@ -60812,6 +60902,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysis extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the parent page object. Read-only. @@ -60869,6 +60961,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysis; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysis object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisData; } /** @@ -60878,6 +60974,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisParagraph extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisPage. Read-only. @@ -60942,6 +61040,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisParagraph; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisParagraph object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphData; } /** @@ -60951,6 +61053,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisParagraphCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisParagraph[]; /** @@ -61004,6 +61108,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisParagraphCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData; } /** @@ -61013,6 +61121,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisLine extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisParagraph. Read-only. @@ -61077,6 +61187,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisLine; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisLine object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineData; } /** @@ -61086,6 +61200,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisLineCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisLine[]; /** @@ -61139,6 +61255,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisLineCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisLineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisLineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisLineCollectionData; } /** @@ -61148,6 +61268,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisWord extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Reference to the parent InkAnalysisLine. Read-only. @@ -61226,6 +61348,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisWord; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkAnalysisWord object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordData; } /** @@ -61235,6 +61361,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkAnalysisWordCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkAnalysisWord[]; /** @@ -61288,6 +61416,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkAnalysisWordCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkAnalysisWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkAnalysisWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkAnalysisWordCollectionData; } /** @@ -61297,6 +61429,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class FloatingInk extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the strokes of the FloatingInk object. Read-only. @@ -61347,6 +61481,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.FloatingInk; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.FloatingInk object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.FloatingInkData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.FloatingInkData; } /** @@ -61356,6 +61494,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkStroke extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the ID of the InkStroke object. Read-only. @@ -61399,6 +61539,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkStroke; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkStroke object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkStrokeData; } /** @@ -61408,6 +61552,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkStrokeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkStroke[]; /** @@ -61461,6 +61607,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkStrokeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkStrokeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkStrokeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkStrokeCollectionData; } /** @@ -61470,6 +61620,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkWord extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The parent paragraph containing the ink word. Read-only. @@ -61527,6 +61679,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkWord; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.InkWord object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.InkWordData; } /** @@ -61536,6 +61692,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class InkWordCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.InkWord[]; /** @@ -61589,6 +61747,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.InkWordCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.InkWordCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.InkWordCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.InkWordCollectionData; } /** @@ -61598,6 +61760,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Notebook extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The section groups in the notebook. Read only @@ -61701,6 +61865,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Notebook; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Notebook object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.NotebookData; } /** @@ -61710,6 +61878,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class NotebookCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Notebook[]; /** @@ -61772,6 +61942,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.NotebookCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.NotebookCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NotebookCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.NotebookCollectionData; } /** @@ -61781,6 +61955,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the notebook that contains the section group. Read-only. @@ -61891,6 +62067,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionGroup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.SectionGroup object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.SectionGroupData; } /** @@ -61900,6 +62080,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionGroupCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.SectionGroup[]; /** @@ -61962,6 +62144,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionGroupCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.SectionGroupCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionGroupCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.SectionGroupCollectionData; } /** @@ -61971,6 +62157,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Section extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the notebook that contains the section. Read-only. @@ -62124,6 +62312,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Section; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Section object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.SectionData; } /** @@ -62133,6 +62325,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class SectionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Section[]; /** @@ -62195,6 +62389,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.SectionCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.SectionCollectionData; } /** @@ -62204,6 +62402,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Page extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * The collection of PageContent objects on the page. Read only @@ -62387,6 +62587,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Page; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Page object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.PageData; } /** @@ -62396,6 +62600,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Page[]; /** @@ -62458,6 +62664,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.PageCollectionData; } /** @@ -62467,6 +62677,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageContent extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. @@ -62573,6 +62785,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageContent; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.PageContent object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.PageContentData; } /** @@ -62582,6 +62798,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class PageContentCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.PageContent[]; /** @@ -62635,6 +62853,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.PageContentCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.PageContentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.PageContentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.PageContentCollectionData; } /** @@ -62644,6 +62866,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Outline extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. @@ -62741,6 +62965,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Outline; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Outline object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.OutlineData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.OutlineData; } /** @@ -62750,6 +62978,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Paragraph extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Image object in the Paragraph. Throws an exception if ParagraphType is not Image. Read-only. @@ -62999,6 +63229,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Paragraph; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Paragraph object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ParagraphData; } /** @@ -63008,6 +63242,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class ParagraphCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.Paragraph[]; /** @@ -63061,6 +63297,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.ParagraphCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.ParagraphCollectionData; } /** @@ -63070,6 +63310,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class NoteTag extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Id of the NoteTag object. Read-only. @@ -63120,6 +63362,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.NoteTag; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.NoteTag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.NoteTagData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.NoteTagData; } /** @@ -63129,6 +63375,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class RichText extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Paragraph object that contains the RichText object. Read-only. @@ -63194,6 +63442,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.RichText; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.RichText object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.RichTextData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.RichTextData; } /** @@ -63203,6 +63455,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Image extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent. This object defines the position of the Image on the page. Read-only. @@ -63310,6 +63564,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Image; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Image object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.ImageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.ImageData; } /** @@ -63319,6 +63577,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the Paragraph object that contains the Table object. Read-only. @@ -63467,6 +63727,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.Table; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.Table object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableData; } /** @@ -63476,6 +63740,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the cells in the row. Read-only. @@ -63575,6 +63841,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableRow; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.TableRow object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableRowData; } /** @@ -63584,6 +63854,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableRow[]; /** @@ -63637,6 +63909,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableRowCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.TableRowCollectionData; } /** @@ -63646,6 +63922,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableCell extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** * * Gets the collection of Paragraph objects in the TableCell. Read-only. @@ -63778,6 +64056,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableCell; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original OneNote.TableCell object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): OneNote.Interfaces.TableCellData; } /** @@ -63787,6 +64069,8 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: OneNote.TableCell[]; /** @@ -63840,6 +64124,10 @@ declare namespace OneNote { * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */ untrack(): OneNote.TableCellCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `OneNote.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `OneNote.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): OneNote.Interfaces.TableCellCollectionData; } /** @@ -64300,13 +64588,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ page?: OneNote.Interfaces.PageData; - /** - * - * Gets the ink analysis paragraphs in this page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraphs?: OneNote.Interfaces.InkAnalysisParagraphData[]; /** * * Gets the ID of the InkAnalysis object. Read-only. @@ -64422,13 +64703,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ inkStrokes?: OneNote.Interfaces.InkStrokeData[]; - /** - * - * Gets the PageContent parent of the FloatingInk object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; /** * * Gets the ID of the FloatingInk object. Read-only. @@ -64460,13 +64734,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "inkWord.toJSON()". */ interface InkWordData { - /** - * - * The parent paragraph containing the ink word. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets the ID of the InkWord object. Read-only. @@ -64551,27 +64818,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "sectionGroup.toJSON()". */ interface SectionGroupData { - /** - * - * Gets the notebook that contains the section group. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - notebook?: OneNote.Interfaces.NotebookData; - /** - * - * Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroup?: OneNote.Interfaces.SectionGroupData; - /** - * - * Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupData; /** * * The collection of section groups in the section group. Read only @@ -64614,13 +64860,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "section.toJSON()". */ interface SectionData { - /** - * - * Gets the notebook that contains the section. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - notebook?: OneNote.Interfaces.NotebookData; /** * * The collection of pages in the section. Read only @@ -64628,20 +64867,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ pages?: OneNote.Interfaces.PageData[]; - /** - * - * Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroup?: OneNote.Interfaces.SectionGroupData; - /** - * - * Gets the section group that contains the section. Returns null if the section is a direct child of the notebook. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupData; /** * * The client url of the section. Read only @@ -64705,13 +64930,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisData; - /** - * - * Gets the section that contains the page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentSection?: OneNote.Interfaces.SectionData; /** * * Gets the ClassNotebookPageSource to the page. @@ -64782,13 +65000,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ outline?: OneNote.Interfaces.OutlineData; - /** - * - * Gets the page that contains the PageContent object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentPage?: OneNote.Interfaces.PageData; /** * * Gets the ID of the PageContent object. Read-only. @@ -64824,13 +65035,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "outline.toJSON()". */ interface OutlineData { - /** - * - * Gets the PageContent object that contains the Outline. This object defines the position of the Outline on the page. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; /** * * Gets the collection of Paragraph objects in the Outline. Read-only. @@ -64864,13 +65068,6 @@ declare namespace OneNote { inkWords?: OneNote.Interfaces.InkWordData[]; /** * - * Gets the Outline object that contains the Paragraph. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - outline?: OneNote.Interfaces.OutlineData; - /** - * * The collection of paragraphs under this paragraph. Read only * * [Api set: OneNoteApi 1.1] @@ -64878,34 +65075,6 @@ declare namespace OneNote { paragraphs?: OneNote.Interfaces.ParagraphData[]; /** * - * Gets the parent paragraph object. Throws if a parent paragraph does not exist. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentParagraph?: OneNote.Interfaces.ParagraphData; - /** - * - * Gets the parent paragraph object. Returns null if a parent paragraph does not exist. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentParagraphOrNull?: OneNote.Interfaces.ParagraphData; - /** - * - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, throws ItemNotFound. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTableCell?: OneNote.Interfaces.TableCellData; - /** - * - * Gets the TableCell object that contains the Paragraph if one exists. If parent is not a TableCell, returns null. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTableCellOrNull?: OneNote.Interfaces.TableCellData; - /** - * * Gets the RichText object in the Paragraph. Throws an exception if ParagraphType is not RichText. Read-only * * [Api set: OneNoteApi 1.1] @@ -64963,13 +65132,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "richText.toJSON()". */ interface RichTextData { - /** - * - * Gets the Paragraph object that contains the RichText object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets the ID of the RichText object. Read-only. @@ -64994,20 +65156,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "image.toJSON()". */ interface ImageData { - /** - * - * 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. - * - * [Api set: OneNoteApi 1.1] - */ - pageContent?: OneNote.Interfaces.PageContentData; - /** - * - * Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets or sets the description of the Image. @@ -65053,13 +65201,6 @@ declare namespace OneNote { } /** An interface describing the data returned by calling "table.toJSON()". */ interface TableData { - /** - * - * Gets the Paragraph object that contains the Table object. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - paragraph?: OneNote.Interfaces.ParagraphData; /** * * Gets all of the table rows. Read-only. @@ -65105,13 +65246,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ cells?: OneNote.Interfaces.TableCellData[]; - /** - * - * Gets the parent table. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentTable?: OneNote.Interfaces.TableData; /** * * Gets the number of cells in the row. Read-only. @@ -65147,13 +65281,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ paragraphs?: OneNote.Interfaces.ParagraphData[]; - /** - * - * Gets the parent row of the cell. Read-only. - * - * [Api set: OneNoteApi 1.1] - */ - parentRow?: OneNote.Interfaces.TableRowData; /** * * Gets the index of the cell in its row. Read-only. @@ -65187,7 +65314,6 @@ declare namespace OneNote { interface TableCellCollectionData { items?: OneNote.Interfaces.TableCellData[]; } - /** * * Represents the top-level object that contains all globally addressable OneNote objects such as notebooks, the active notebook, and the active section. @@ -65219,13 +65345,6 @@ declare namespace OneNote { * [Api set: OneNoteApi 1.1] */ page?: OneNote.Interfaces.PageLoadOptions; - /** - * - * Gets the ink analysis paragraphs in this page. - * - * [Api set: OneNoteApi 1.1] - */ - paragraphs?: OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions; /** * * Gets the ID of the InkAnalysis object. Read-only. @@ -66871,25 +66990,18 @@ declare namespace OneNote { * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the OneNote application. Since the Office add-in and the OneNote application run in two different processes, the request context is required to get access to the OneNote object model from the add-in. */ function run(batch: (context: OneNote.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the OneNote object model, using the request context of a previously-created API object. + * @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + */ + function run(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise): Promise; /** * Executes a batch script that performs actions on the OneNote object model, using the request context of previously-created API objects. * @param object - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared request context, which means that any changes applied to these objects will be picked up by "context.sync()". * @param batch - A function that takes in an OneNote.RequestContext and returns a promise (typically, just the result of "context.sync()"). When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. */ function run(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise): Promise; - /** - * Executes a batch script that performs actions on the OneNote object model, using the request context of a previously-created API object. - * @param object - A previously-created API object. The batch will use the same request context as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". - * @param batch - A function that takes in an OneNote.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. - * - * @remarks - * In addition to this signature, the method also has the following signatures: - * - * `run(batch: (context: OneNote.RequestContext) => Promise): Promise;` - * - * `run(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise): Promise;` - */ - function run(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise): Promise; }