Partager via

Excel.WorksheetProtection class

  • Référence
Paquet:
excel

Représente la protection d’un objet de feuille de calcul.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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

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

Spécifie si la feuille de calcul est protégée.

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(options, password)

Protège une feuille de calcul. Échoue si la feuille de calcul a déjà été protégée.
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 d’origine Excel.WorksheetProtection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorksheetProtectionDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
unprotect(password)

Annule la protection d’une feuille de calcul.

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

options

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

readonly options: Excel.WorksheetProtectionOptions;

Valeur de propriété

Excel.WorksheetProtectionOptions

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

protected

Spécifie si la feuille de calcul est protégée.

readonly protected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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

Paramètres

options
Excel.Interfaces.WorksheetProtectionLoadOptions

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

Retours

Excel.WorksheetProtection

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

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

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

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

protect(options, password)

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

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

Paramètres

options
Excel.WorksheetProtectionOptions

Optional. Options de protection de feuille.

password

string

Optional. Mot de passe de protection de feuille.

Retours

void

Remarques

[ Ensemble 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);
    }
});

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

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Retours

Excel.Interfaces.WorksheetProtectionData

unprotect(password)

Annule la protection d’une feuille de calcul.

unprotect(password?: string): void;

Paramètres

password

string

Mot de passe de protection de feuille.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 pour 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);
});