Excel.SensitivityLabelProtectionType enum

注意

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

表示保护类型。

注解

API 集:ExcelApi BETA (仅预览版)

使用方

示例

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

// Get the sensitivity label currently applied to the workbook.
await Excel.run(async (context) => {
    const workbook: Excel.Workbook = context.workbook;
    const workbookLabel: Excel.SensitivityLabel = workbook.sensitivityLabel;
    const currentLabel: Excel.SensitivityLabelDetails = workbookLabel.getCurrentOrNullObject();
    currentLabel.load(
        "color,id,isAbacAttributesRequired,isAbacEnabled,isEnabled,name,order,protectionType,siteId,tooltip"
    );
    await context.sync();

    if (currentLabel.isNullObject) {
        console.log("The workbook doesn't have a sensitivity label.");
        return;
    }

    // Get ABAC values only when enabled for the label.
    let abacAttributeValues: Excel.SensitivityLabelAbacAttributeValue[] = [];
    if (currentLabel.isAbacEnabled) {
        currentLabel.load("abacAttributeValues");
        await context.sync();

        abacAttributeValues = currentLabel.abacAttributeValues;
    }

    const attributeValues = abacAttributeValues.length
        ? abacAttributeValues
            .map((attributeValue: Excel.SensitivityLabelAbacAttributeValue) =>
                `${attributeValue.displayName} (ID: ${attributeValue.id}, ` +
                `order: ${attributeValue.displayOrder}, active: ${attributeValue.isActive ? "Yes" : "No"})`)
            .join(", ")
        : "None";

    let protectionDescription: string;
    switch (currentLabel.protectionType) {
        case Excel.SensitivityLabelProtectionType.adminDefined:
            protectionDescription = "Defined by an administrator";
            break;
        case Excel.SensitivityLabelProtectionType.userDefined:
            protectionDescription = "Defined by the user";
            break;
        case Excel.SensitivityLabelProtectionType.noProtection:
            protectionDescription = "No protection";
            break;
        default:
            protectionDescription = `Unknown (${currentLabel.protectionType})`;
            break;
    }

    console.log(
        `Current workbook sensitivity label:\n\n${currentLabel.name}\n` +
        `  ID: ${currentLabel.id}\n` +
        `  Site ID: ${currentLabel.siteId}\n` +
        `  Tooltip: ${currentLabel.tooltip}\n` +
        `  Color: ${currentLabel.color}\n` +
        `  Enabled: ${currentLabel.isEnabled ? "Yes" : "No"}\n` +
        `  Display order: ${currentLabel.order}\n` +
        `  ABAC enabled: ${currentLabel.isAbacEnabled ? "Yes" : "No"}\n` +
        `  ABAC attributes required: ${currentLabel.isAbacAttributesRequired ? "Yes" : "No"}\n` +
        `  ABAC attribute values: ${attributeValues}\n` +
        `  Protection type: ${protectionDescription}`
    );
});

字段

adminDefined = "AdminDefined"

保护由管理员定义。

noProtection = "NoProtection"

此标签不应用任何保护。

userDefined = "UserDefined"

保护由用户定义。