CustomFunctions.CancelableInvocation interface
Provides information about the invocation of a cancelable custom function. A cancelable custom function can provide a handler for the onCanceled event.
To indicate that a function is cancelable, in the metadata JSON file, the function options should specify: { "cancelable": true }
If the metadata JSON file is being generated from JSDoc comments, include the tag @cancelable
.
- Extends
Events
on |
Event handler called when the custom function is canceled. |
Event Details
onCanceled
Event handler called when the custom function is canceled.
onCanceled?: () => void;
Event Type
() => void
Remarks
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins