Excel.WorkbookProtection class

Paquet:

excel

Représente la protection d’un objet classeur.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
protected	Spécifie si le classeur est protégé.

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.
protect(password)	Protège un classeur. Échoue si le classeur est protégé.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.WorkbookProtection d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.WorkbookProtectionDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
unprotect(password)	Annule la protection un classeur.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

protected

Spécifie si le classeur est protégé.

readonly protected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Détails de la méthode

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(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection;

Paramètres

options

Excel.Interfaces.WorkbookProtectionLoadOptions

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

Retours

Excel.WorkbookProtection

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(propertyNames?: string | string[]): Excel.WorkbookProtection;

Paramètres

propertyNames

string | string[]

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

Retours

Excel.WorkbookProtection

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.

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

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.WorkbookProtection

protect(password)

Protège un classeur. Échoue si le classeur est protégé.

protect(password?: string): void;

Paramètres

password

string

Mot de passe de protection du classeur.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml

let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.load("protection/protected");

    await context.sync();

    if (!workbook.protection.protected) {
        workbook.protection.protect(password);
    }
});

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.WorkbookProtection d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.WorkbookProtectionDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.WorkbookProtectionData;

Retours

Excel.Interfaces.WorkbookProtectionData

unprotect(password)

Annule la protection un classeur.

unprotect(password?: string): void;

Paramètres

password

string

Mot de passe de protection du classeur.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml

let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let workbook = context.workbook;
    workbook.protection.unprotect(password);
});