Excel.WorksheetProtection class

Spécifie l’objet AllowEditRangeCollection trouvé dans cette feuille de calcul. Il s’agit d’une collection d’objets qui fonctionnent avec les propriétés de protection de la feuille de AllowEditRange calcul. Lorsque la protection de la feuille de calcul est activée, un AllowEditRange objet peut être utilisé pour autoriser la modification d’une plage spécifique, tout en conservant la protection sur le reste de la feuille de calcul.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

Spécifie si la protection peut être suspendue pour cette feuille de calcul.

readonly canPauseProtection: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

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é

Indique si la feuille est protégée par mot de passe.

readonly isPasswordProtected: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

Spécifie si la protection de la feuille de calcul est suspendue.

readonly isPaused: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

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

Spécifie les options de protection enregistrées dans la feuille de calcul. Cette opération renvoie le même WorksheetProtectionOptions objet quel que soit l’état de protection de la feuille de calcul.

readonly savedOptions: Excel.WorksheetProtectionOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

Indique si le mot de passe peut être utilisé pour déverrouiller la protection de la feuille de calcul. Cette méthode ne modifie pas l’état de protection de la feuille de calcul. Si un mot de passe est entré mais qu’aucun mot de passe n’est requis pour déverrouiller la protection de la feuille de calcul, cette méthode renvoie false.

checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;

Paramètres

Retours

Indique true si le mot de passe peut être utilisé pour déverrouiller la protection d’une feuille de calcul. Sinon, retourne false.

Remarques

Jeu d’API : ExcelApiOnline 1.1

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

Suspend la protection de la feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur dans la session active. Cette méthode ne fait rien si la protection de la feuille de calcul n’est pas activée ou est déjà suspendue. Si le mot de passe est incorrect, cette méthode génère une InvalidArgument erreur et ne met pas la protection en pause. Cette méthode ne modifie pas l’état de protection si la protection de la feuille de calcul n’est pas activée ou est déjà suspendue.

pauseProtection(password?: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1

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

Reprend la protection de la feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur dans une session donnée. La protection de la feuille de calcul doit être suspendue pour que cette méthode fonctionne. Si la protection de la feuille de calcul n’est pas suspendue, cette méthode ne modifie pas l’état de protection de la feuille de calcul.

resumeProtection(): void;

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1

Modifie le mot de passe associé à l’objet WorksheetProtection . La définition du mot de passe en tant que chaîne vide («  ») ou en tant que null supprimera la protection par mot de passe de l’objet WorksheetProtection . La protection de la feuille de calcul doit être activée et suspendue pour que cette méthode fonctionne correctement. Si la protection de la feuille de calcul est désactivée, cette méthode génère une InvalidOperation erreur et ne parvient pas à modifier le mot de passe. Si la protection de la feuille de calcul est activée et n’est pas suspendue, cette méthode génère une AccessDenied erreur et ne parvient pas à modifier le mot de passe.

setPassword(password?: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1

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

Modifier les options de protection de la feuille de calcul associées à l’objet WorksheetProtection . La protection de la feuille de calcul doit être désactivée ou suspendue pour que cette méthode fonctionne correctement. Si la protection de la feuille de calcul est activée et n’est pas suspendue, cette méthode génère une AccessDenied erreur et ne modifie pas les options de protection de la feuille de calcul.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiOnline 1.1