Excel.SensitivityLabelDetails class

Paquet:
excel

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.

Représente les propriétés des étiquettes de confidentialité disponibles dans Excel.

Extends
OfficeExtension.ClientObject

Remarques

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

Utilisateur

Propriétés

children

Obtient les sous-étiquettes de l’étiquette de confidentialité. Renvoie null si une étiquette n’a pas de sous-étiquettes.
color

Récupère la couleur de l’étiquette de confidentialité.
context

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

Obtient l’identificateur unique (GUID) de l’étiquette de confidentialité.
isEnabled

Obtient une valeur indiquant si l’étiquette est activée.
name

Récupère le nom de l’étiquette de confidentialité.
order

Obtient la priorité de l’étiquette de confidentialité, avec 0 comme priorité la plus basse.
protectionType

Obtient une valeur indiquant le type de protection fourni par cette étiquette.
siteId

Obtient l’identificateur unique (GUID) du client auquel appartient l’étiquette de confidentialité.
tooltip

Obtient la description de l’étiquette de confidentialité.

Méthodes

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.SensitivityLabelDetails est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.SensitivityLabelDetailsDataqui 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é

children

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 sous-étiquettes de l’étiquette de confidentialité. Renvoie null si une étiquette n’a pas de sous-étiquettes.

readonly children: SensitivityLabelDetailsCollection | null;

Valeur de propriété

Excel.SensitivityLabelDetailsCollection | null

Remarques

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

color

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.

Récupère la couleur de l’étiquette de confidentialité.

readonly color: string;

Valeur de propriété

string

Remarques

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

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é

Excel.RequestContext

id

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 l’identificateur unique (GUID) de l’étiquette de confidentialité.

readonly id: string;

Valeur de propriété

string

Remarques

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

isEnabled

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 une valeur indiquant si l’étiquette est activée.

readonly isEnabled: boolean;

Valeur de propriété

boolean

Remarques

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

name

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.

Récupère le nom de l’étiquette de confidentialité.

readonly name: string;

Valeur de propriété

string

Remarques

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

order

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 la priorité de l’étiquette de confidentialité, avec 0 comme priorité la plus basse.

readonly order: number;

Valeur de propriété

number

Remarques

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

protectionType

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 une valeur indiquant le type de protection fourni par cette étiquette.

readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";

Valeur de propriété

Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

Remarques

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

siteId

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 l’identificateur unique (GUID) du client auquel appartient l’étiquette de confidentialité.

readonly siteId: string;

Valeur de propriété

string

Remarques

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

tooltip

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 la description de l’étiquette de confidentialité.

readonly tooltip: string;

Valeur de propriété

string

Remarques

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

Détails de la méthode

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.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;

Paramètres

options
Excel.Interfaces.SensitivityLabelDetailsLoadOptions

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

Retours

Excel.SensitivityLabelDetails

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.SensitivityLabelDetails;

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

Excel.SensitivityLabelDetails

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.SensitivityLabelDetails;

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

Excel.SensitivityLabelDetails

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.SensitivityLabelDetails est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.SensitivityLabelDetailsDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;

Retours

Excel.Interfaces.SensitivityLabelDetailsData