PowerPoint.SensitivityLabelDetailsCollection class

注意

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

表示 PowerPoint.SensitivityLabelDetails 对象的集合。

注解

使用方

属性

context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

getCount()	获取此集合中 PowerPoint.SensitivityLabelDetails 对象的数量。
getItem(id)	获取此集合中的指定 `SensitivityLabelDetails` 对象。如果未找到具有指定 ID 的项目，则引发 `ItemNotFound` 错误。
getItemAt(index)	获取 `SensitivityLabelDetails` 此集合中指定索引处的对象。如果索引超出范围，则引发 `IndexOutOfRange` 错误。
getItemOrNullObject(id)	获取此集合中的指定 `SensitivityLabelDetails` 对象。如果找不到具有指定 ID 的项目，则此方法将返回其 `isNullObject` 属性设置为 `true`的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `PowerPoint.SensitivityLabelDetailsCollection` 对象是 API 对象，但该 `toJSON` 方法返回一个纯 JavaScript 对象， (类型为 `PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData`) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

context

注意

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

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

context: RequestContext;

属性值

PowerPoint.RequestContext

items

注意

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

获取此集合中已加载的子项。

readonly items: PowerPoint.SensitivityLabelDetails[];

属性值

PowerPoint.SensitivityLabelDetails[]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/preview-apis/manage-sensitivity-labels.yaml

await PowerPoint.run(async (context) => {
  const labelSelect = document.getElementById("label-id") as HTMLSelectElement;
  labelSelect.options.length = 0;
  const placeholder = document.createElement("option");
  placeholder.textContent = "Select a label";
  placeholder.value = "";
  labelSelect.add(placeholder);

  // Get the sensitivity labels that the organization published for the current user.
  const labelCatalog: PowerPoint.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
  if (!labelCatalog) {
    console.warn("The sensitivity label catalog isn't available.");
    return;
  }

  const availableLabels: PowerPoint.SensitivityLabelDetailsCollection = labelCatalog.getLabels();
  // Load the properties and sublabels for every label in the catalog.
  availableLabels.load(
    "items/color,items/id,items/isAbacAttributesRequired,items/isAbacEnabled,items/isEnabled," +
    "items/name,items/order,items/protectionType,items/siteId,items/tooltip," +
    "items/children/items/id,items/children/items/name,items/children/items/isEnabled"
  );
  await context.sync();

  if (availableLabels.items.length === 0) {
    console.log("No sensitivity labels are available for the current user.");
    return;
  }

  // Display the loaded properties for each available label.
  console.log("Available sensitivity labels:");
  availableLabels.items.forEach((labelDetails: PowerPoint.SensitivityLabelDetails) => {
    const childLabels = labelDetails.children && labelDetails.children.items.length
      ? labelDetails.children.items
          .map((childLabel: PowerPoint.SensitivityLabelDetails) => `${childLabel.name} (${childLabel.id})`)
          .join(", ")
      : "None";

    console.log(
      `\n${labelDetails.name}\n` +
        `  ID: ${labelDetails.id}\n` +
        `  Site ID: ${labelDetails.siteId}\n` +
        `  Tooltip: ${labelDetails.tooltip}\n` +
        `  Color: ${labelDetails.color}\n` +
        `  Enabled: ${labelDetails.isEnabled ? "Yes" : "No"}\n` +
        `  Display order: ${labelDetails.order}\n` +
        `  ABAC enabled: ${labelDetails.isAbacEnabled ? "Yes" : "No"}\n` +
        `  ABAC attributes required: ${labelDetails.isAbacAttributesRequired ? "Yes" : "No"}\n` +
        `  Sublabels: ${childLabels}\n` +
        `  Protection type: ${labelDetails.protectionType}`
    );
  });

  addLabelOptions(availableLabels);
});

getCount()

注意

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

获取此集合中 PowerPoint.SensitivityLabelDetails 对象的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

对象数量 SensitivityLabelDetails 。

注解

API 集：PowerPointApi BETA (仅预览版)

getItem(id)

注意

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

获取此集合中的指定 SensitivityLabelDetails 对象。如果未找到具有指定 ID 的项目，则引发 ItemNotFound 错误。

getItem(id: string): PowerPoint.SensitivityLabelDetails;

参数

id: string

敏感度标签的 ID。

返回

PowerPoint.SensitivityLabelDetails

指定的 SensitivityLabelDetails 对象。

注解

API 集：PowerPointApi BETA (仅预览版)

getItemAt(index)

注意

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

获取 SensitivityLabelDetails 此集合中指定索引处的对象。如果索引超出范围，则引发 IndexOutOfRange 错误。

getItemAt(index: number): PowerPoint.SensitivityLabelDetails;

参数

index: number

要检索的项目的索引。从零开始编制索引。

返回

PowerPoint.SensitivityLabelDetails

指定索引处的 SensitivityLabelDetails 对象。

注解

API 集：PowerPointApi BETA (仅预览版)

getItemOrNullObject(id)

注意

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

获取此集合中的指定 SensitivityLabelDetails 对象。如果找不到具有指定 ID 的项目，则此方法将返回其 isNullObject 属性设置为 true的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(id: string): PowerPoint.SensitivityLabelDetails;

参数

id: string

敏感度标签的 ID。

返回

PowerPoint.SensitivityLabelDetails

指定的 SensitivityLabelDetails 对象。

注解

API 集：PowerPointApi BETA (仅预览版)

load(options)

注意

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

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SensitivityLabelDetailsCollection;

参数

options: PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

为要加载的对象属性提供选项。

返回

PowerPoint.SensitivityLabelDetailsCollection

load(propertyNames)

注意

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

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelDetailsCollection;

参数

propertyNames: string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

PowerPoint.SensitivityLabelDetailsCollection

load(propertyNamesAndPaths)

注意

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

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SensitivityLabelDetailsCollection;

参数

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

PowerPoint.SensitivityLabelDetailsCollection

toJSON()

注意

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

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.SensitivityLabelDetailsCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData;

返回

PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData

注解

使用方

属性

方法

属性详细信息

context

属性值

items

属性值

示例

方法详细信息

getCount()

返回

注解

getItem(id)

参数

返回

注解

getItemAt(index)

参数

返回

注解

getItemOrNullObject(id)

参数

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

反馈