StartAction

指定长时间操作的开始操作。

备注

GroupActions 仅适用于 ONLYOFFICE Docs Enterprise 和 ONLYOFFICE Docs Developer。

语法

expression.StartAction(type, description);

expression - 表示 Api 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
type	必需	"Information" | "Block" | "GroupActions"		操作类型："Information" - 非阻塞信息操作，"Block" - 阻塞交互操作，"GroupActions" - 将多个编辑器操作分组为单个可撤销步骤。
description	可选	string | Object		对于 "Information" 和 "Block" 类型：在操作期间显示的字符串描述。对于 "GroupActions" 类型：具有以下属性的可选对象：
description.lockScroll	可选	boolean		如果为 true，编辑器的滚动位置将在组操作期间被锁定。
description.keepSelection	可选	boolean		如果为 true，组操作结束后将保留光标位置和选区。

返回值

此方法不返回任何数据。

示例

window.Asc.plugin.executeMethod ("StartAction", ["Block", "Save to local storage..."], function () {
    setPasswordByFile ("sha256", "123456");

    setTimeout (function () {
        window.Asc.plugin.executeMethod ("EndAction", ["Block", "Save to localstorage..."]);
    }, 200);
});