跳到主要内容

OnEncryption

加密文档。

语法

expression.OnEncryption(obj);

expression - 表示 Api 类的变量。

参数

名称必需/可选数据类型默认值描述
obj必需object加密属性。
obj.type必需string加密操作类型:generatePassword - 为文档生成密码,getPasswordByFile - 打开文档时发送密码,encryptData - 协作编辑时加密更改,decryptData - 协作编辑时解密更改。
obj.password必需string指定访问文档密码的字符串值。
obj.data必需string加密/解密的更改。
obj.check必需boolean检查加密/解密操作是否成功(仅用于 encryptDatadecryptData 类型)。
obj.docinfo必需string加密文件的未加密部分。
obj.hash必需string指定文件哈希值的字符串值(默认为 sha256)。
obj.error必需string指定发生错误的字符串值("" 值表示操作成功)。

返回值

此方法不返回任何数据。

示例

window.Asc.plugin.executeMethod ("OnEncryption", [
{
"type": "getPasswordByFile",
"password": "123456",
"docinfo": "{docinfo}",
"hash": "sha256"
}
]);