EndAction
Specifies the end action for long operations.
note
GroupActions are available only for ONLYOFFICE Docs Enterprise and ONLYOFFICE Docs Developer.
Syntax
expression.EndAction(type, description, status);
expression - A variable that represents an Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| type | Required | "Information" | "Block" | "GroupActions" | The action type: "Information" - ends a non-blocking informational action, "Block" - ends a blocking interaction action, "GroupActions" - ends the grouped operations started with StartAction("GroupActions"). | |
| description | Optional | string | Object | For "Information" and "Block" types: a string description displayed during the action. For "GroupActions" type: an optional object with the following properties: | |
| description.scrollToTarget | Optional | boolean | true | If false, the editor will not scroll to the target after the group operation ends. |
| description.cancel | Optional | boolean | false | If true, the group operation is cancelled and rolled back instead of committed. |
| status | Optional | string | For "Information" and "Block" types: the error status code. If no error occurs, then an empty string is passed. |
Returns
This method doesn't return any data.
Example
window.Asc.plugin.executeMethod ("EndAction", ["Block", "Save to local storage...", ""]);