Excel.SensitivityLabelDetails class
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示 Excel 中可用敏感度标签的属性。
注解
使用方
属性
| children | 获取敏感度标签的子标签。 如果标签没有任何子标签，则返回 |
| color | 获取敏感度标签的颜色。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取敏感度标签的唯一标识符 (GUID) 。 |
| is |
获取指示是否启用标签的值。 |
| name | 获取敏感度标签的名称。 |
| order | 获取敏感度标签的优先级，其中 0 为最低优先级。 |
| protection |
获取指示此标签提供的保护类型的值。 |
| site |
获取敏感度标签所属租户的唯一标识符 (GUID) 。 |
| tooltip | 获取敏感度标签的说明。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
children
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的子标签。 如果标签没有任何子标签，则返回 null 。
readonly children: SensitivityLabelDetailsCollection | null;属性值
注解
color
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的颜色。
readonly color: string;属性值
string
注解
context
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
context: RequestContext;属性值
id
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的唯一标识符 (GUID) 。
readonly id: string;属性值
string
注解
isEnabled
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取指示是否启用标签的值。
readonly isEnabled: boolean;属性值
boolean
注解
name
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的名称。
readonly name: string;属性值
string
注解
order
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的优先级，其中 0 为最低优先级。
readonly order: number;属性值
number
注解
protectionType
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取指示此标签提供的保护类型的值。
readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";属性值
Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"
注解
siteId
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签所属租户的唯一标识符 (GUID) 。
readonly siteId: string;属性值
string
注解
tooltip
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取敏感度标签的说明。
readonly tooltip: string;属性值
string
注解
方法详细信息
load(options)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.SensitivityLabelDetails;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SensitivityLabelDetails 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.SensitivityLabelDetailsData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;