Excel.SensitivityLabelsCatalog class

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Fournit des méthodes pour case activée le status du catalogue d’étiquettes de confidentialité dans Excel et récupérer toutes les étiquettes de confidentialité disponibles si le catalogue est activé.

Extends

Propriétés

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

getLabelingCapabilities

Obtient les fonctionnalités d’étiquetage pour Excel. Permet Array.includes de déterminer si une capacité est disponible.

getLabelingCapability

Détermine si le catalogue d’étiquettes de confidentialité est activé dans Excel.

Méthodes

getAttributes()

Obtient les métadonnées du catalogue d’attributs du contrôle d’accès basé sur les attributs (ABAC) pour les étiquettes compatibles ABAC. Vérifiez que les fonctionnalités d’étiquetage de l’hôte incluent attributeBasedAccessControlEnabled; dans le cas contraire, cette méthode échoue avec une erreur.

getLabels()

Obtient les étiquettes de confidentialité disponibles pour l’utilisateur actuel.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.SensitivityLabelsCatalog est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.SensitivityLabelsCatalogDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

getLabelingCapabilities

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient les fonctionnalités d’étiquetage pour Excel. Permet Array.includes de déterminer si une capacité est disponible.

readonly getLabelingCapabilities: Excel.LabelingCapability[];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

getLabelingCapability

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Détermine si le catalogue d’étiquettes de confidentialité est activé dans Excel.

readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" | "AttributeBasedAccessControlEnabled";

Valeur de propriété

Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" | "AttributeBasedAccessControlEnabled"

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Détails de la méthode

getAttributes()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient les métadonnées du catalogue d’attributs du contrôle d’accès basé sur les attributs (ABAC) pour les étiquettes compatibles ABAC. Vérifiez que les fonctionnalités d’étiquetage de l’hôte incluent attributeBasedAccessControlEnabled; dans le cas contraire, cette méthode échoue avec une erreur.

getAttributes(): OfficeExtension.ClientResult<SensitivityLabelAbacAttribute[]>;

Retours

Attributs ABAC disponibles pour l’utilisateur actuel.

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

getLabels()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient les étiquettes de confidentialité disponibles pour l’utilisateur actuel.

getLabels(): Excel.SensitivityLabelDetailsCollection;

Retours

Objet actuel SensitivityLabelDetailsCollection .

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

load(options)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog;

Paramètres

options
Excel.Interfaces.SensitivityLabelsCatalogLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.SensitivityLabelsCatalog;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

toJSON()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.SensitivityLabelsCatalog est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.SensitivityLabelsCatalogDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData;

Retours