Excel.SensitivityLabel class

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示工作簿上的敏感度标签。

扩展

属性

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

方法

getCurrentOrNullObject()

获取用户工作簿上存在的当前标签信息。 如果当前工作簿上没有敏感度标签,则返回属性设置为 的true对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性。

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SensitivityLabel 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Excel.Interfaces.SensitivityLabelData) ,其中包含从原始对象加载的任何子属性的浅层副本。

tryToUpdate(labelId, options)

尝试更新到用户工作簿上提供的敏感度标签。

属性详细信息

context

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

方法详细信息

getCurrentOrNullObject()

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取用户工作簿上存在的当前标签信息。 如果当前工作簿上没有敏感度标签,则返回属性设置为 的true对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性。

getCurrentOrNullObject(): Excel.SensitivityLabelDetails;

返回

当前 SensitivityLabelDetails 对象。

注解

API 集:ExcelApi BETA (仅预览版)

toJSON()

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SensitivityLabel 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Excel.Interfaces.SensitivityLabelData) ,其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): {
            [key: string]: string;
        };

返回

{ [key: string]: string; }

tryToUpdate(labelId, options)

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

尝试更新到用户工作簿上提供的敏感度标签。

tryToUpdate(labelId: string, options?: Excel.SensitivityLabelTryUpdateOptions): OfficeExtension.ClientResult<Excel.SensitivityLabelUpdateResult>;

参数

labelId

string

要应用的标签的 ID。

options
Excel.SensitivityLabelTryUpdateOptions

可选。 其他输入,例如 ABAC 属性。

返回

SensitivityLabelUpdateResult对象。

注解

API 集:ExcelApi BETA (仅预览版)