diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index f9e8ffa617..707280d970 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -788,7 +788,7 @@ declare namespace Office { * * 12005 * The URL passed to displayDialogAsync uses the HTTP protocol. HTTPS is required. (In some versions of Office, the error message returned with 12005 is the same one returned for 12004.) - * 7 + * * * 12007 * A dialog box is already opened from the task pane. A task pane add-in can only have one dialog box open at a time. @@ -1645,6 +1645,9 @@ declare namespace Office { enum EventType { /** * A Document.ActiveViewChanged event was raised. + * + * @remarks + * **Hosts**: PowerPoint */ ActiveViewChanged, /** @@ -1665,12 +1668,17 @@ declare namespace Office { * Occurs when data within the binding is changed. * To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object. * The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}. + * + * @remarks + * **Hosts**: Access, Excel, Word */ BindingDataChanged, /** * Occurs when the selection is changed within the binding. To add an event handler for the BindingSelectionChanged event of a binding, use * the addHandlerAsync method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}. * + * @remarks + * **Hosts**: Access, Excel, Word */ BindingSelectionChanged, /** @@ -1683,6 +1691,9 @@ declare namespace Office { DialogEventReceived, /** * Triggers when a document-level selection happens. + * + * @remarks + * **Hosts**: Excel, Word */ DocumentSelectionChanged, /** @@ -1735,6 +1746,9 @@ declare namespace Office { ResourceSelectionChanged, /** * A Settings.settingsChanged event was raised. + * + * @remarks + * **Hosts**: Access, Excel, PowerPoint, Word */ SettingsChanged, /** @@ -4333,7 +4347,7 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -4374,7 +4388,7 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -4420,7 +4434,7 @@ declare namespace Office { * Reads all settings persisted in the document and refreshes the content or task pane add-in's copy of those settings held in memory. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against * the same document. Because each add-in is working against an in-memory copy of the settings loaded from the document at the time the user @@ -4477,7 +4491,7 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -4497,7 +4511,7 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -5152,7 +5166,6 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * **Hosts**: Excel * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -5190,7 +5203,6 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * **Hosts**: Excel * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 6705fee22d..8dcff1b106 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -782,7 +782,7 @@ declare namespace Office { * * 12005 * The URL passed to displayDialogAsync uses the HTTP protocol. HTTPS is required. (In some versions of Office, the error message returned with 12005 is the same one returned for 12004.) - * 7 + * * * 12007 * A dialog box is already opened from the task pane. A task pane add-in can only have one dialog box open at a time. @@ -1564,6 +1564,9 @@ declare namespace Office { enum EventType { /** * A Document.ActiveViewChanged event was raised. + * + * @remarks + * **Hosts**: PowerPoint */ ActiveViewChanged, /** @@ -1584,12 +1587,17 @@ declare namespace Office { * Occurs when data within the binding is changed. * To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object. * The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}. + * + * @remarks + * **Hosts**: Access, Excel, Word */ BindingDataChanged, /** * Occurs when the selection is changed within the binding. To add an event handler for the BindingSelectionChanged event of a binding, use * the addHandlerAsync method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}. * + * @remarks + * **Hosts**: Access, Excel, Word */ BindingSelectionChanged, /** @@ -1602,6 +1610,9 @@ declare namespace Office { DialogEventReceived, /** * Triggers when a document-level selection happens. + * + * @remarks + * **Hosts**: Excel, Word */ DocumentSelectionChanged, /** @@ -1654,6 +1665,9 @@ declare namespace Office { ResourceSelectionChanged, /** * A Settings.settingsChanged event was raised. + * + * @remarks + * **Hosts**: Access, Excel, PowerPoint, Word */ SettingsChanged, /** @@ -4252,7 +4266,7 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -4293,7 +4307,7 @@ declare namespace Office { * spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique. * @@ -4339,7 +4353,7 @@ declare namespace Office { * Reads all settings persisted in the document and refreshes the content or task pane add-in's copy of those settings held in memory. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against * the same document. Because each add-in is working against an in-memory copy of the settings loaded from the document at the time the user @@ -4396,7 +4410,7 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -4416,7 +4430,7 @@ declare namespace Office { * Removes an event handler for the settingsChanged event. * * @remarks - * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#settings | Settings} + * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType * will be removed. @@ -5071,7 +5085,6 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * **Hosts**: Excel * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information. @@ -5109,7 +5122,6 @@ declare namespace Office { * Updates table formatting options on the bound table. * * @remarks - * **Hosts**: Excel * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set} * * In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.