Excel.WorksheetProtection class

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é

Spécifie les options de protection pour la feuille de calcul.

readonly options: Excel.WorksheetProtectionOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Indique si la feuille de calcul est protégée.

readonly protected: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

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.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

Protège une feuille de calcul. Échoue si la feuille de calcul est déjà protégée.

protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2 pour les options ; 1.7 pour le mot de passe

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 activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.load("protection/protected");

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect(null, password);
    }
});

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

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Retours

Annule la protection d’une feuille de calcul.

unprotect(password?: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.7 pour le mot de passe

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 activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect(password);
});