Excel.WorksheetProtection class

Référence

Paquet:: excel

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

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

allowEditRanges	Spécifie l’objet `AllowEditRangeCollection` trouvé dans cette feuille de calcul. Il s’agit d’une collection d’objets `AllowEditRange` qui fonctionnent avec les propriétés de protection de feuille de calcul. Lorsque la protection de feuille de calcul est activée, un `AllowEditRange` objet peut être utilisé pour permettre la modification d’une plage spécifique, tout en conservant la protection sur le reste de la feuille de calcul.
canPauseProtection	Spécifie si la protection peut être suspendue pour cette feuille de calcul.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
isPasswordProtected	Spécifie si la feuille est protégée par mot de passe.
isPaused	Spécifie si la protection de la feuille de calcul est suspendue.
options	Spécifie les options de protection de la feuille de calcul.
protected	Spécifie si la feuille de calcul est protégée.
savedOptions	Spécifie les options de protection enregistrées dans la feuille de calcul. Cette opération retourne le même `WorksheetProtectionOptions` objet, quel que soit l’état de protection de la feuille de calcul.

Méthodes

checkPassword(password)	Spécifie si le mot de passe peut être utilisé pour déverrouiller la protection de 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 retourne false.
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.
pauseProtection(password)	Suspend la protection de la feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur de la session active. Cette méthode ne fait rien si la protection de 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 parvient pas à suspendre la protection. Cette méthode ne modifie pas l’état de protection si la protection de feuille de calcul n’est pas activée ou déjà suspendue.
protect(options, password)	Protège une feuille de calcul. Échoue si la feuille de calcul a déjà été protégée.
resumeProtection()	Reprend la protection de 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.
setPassword(password)	Modifie le mot de passe associé à l’objet `WorksheetProtection` . La définition du mot de passe sous la forme d’une chaîne vide (« ») ou comme `null` supprime la protection par mot de passe de l’objet `WorksheetProtection` . La protection de feuille de calcul doit être activée et suspendue pour que cette méthode fonctionne correctement. Si la protection de 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 feuille de calcul est activée et non suspendue, cette méthode génère une `AccessDenied` erreur et ne parvient pas à modifier le mot de passe.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à 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.WorksheetProtectionData`que ) 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.
updateOptions(options)	Modifiez les options de protection de feuille de calcul associées à l’objet `WorksheetProtection` . La protection de feuille de calcul doit être désactivée ou suspendue pour que cette méthode fonctionne correctement. Si la protection de feuille de calcul est activée et non suspendue, cette méthode génère une `AccessDenied` erreur et ne parvient pas à modifier les options de protection de feuille de calcul.

Détails de la propriété

allowEditRanges

Spécifie l’objet AllowEditRangeCollection trouvé dans cette feuille de calcul. Il s’agit d’une collection d’objets AllowEditRange qui fonctionnent avec les propriétés de protection de feuille de calcul. Lorsque la protection de feuille de calcul est activée, un AllowEditRange objet peut être utilisé pour permettre 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é

Excel.AllowEditRangeCollection

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

canPauseProtection

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

readonly canPauseProtection: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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

isPasswordProtected

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

readonly isPasswordProtected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

isPaused

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

readonly isPaused: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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 ]

savedOptions

Spécifie les options de protection enregistrées dans la feuille de calcul. Cette opération retourne 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é

Excel.WorksheetProtectionOptions

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Détails de la méthode

checkPassword(password)

Spécifie si le mot de passe peut être utilisé pour déverrouiller la protection de 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 retourne false.

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

Paramètres

password: string

Mot de passe à case activée sur la feuille de calcul protégée.

Retours

OfficeExtension.ClientResult<boolean>

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

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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

pauseProtection(password)

Suspend la protection de la feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur de la session active. Cette méthode ne fait rien si la protection de 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 parvient pas à suspendre la protection. Cette méthode ne modifie pas l’état de protection si la protection de feuille de calcul n’est pas activée ou déjà suspendue.

pauseProtection(password?: string): void;

Paramètres

password: string

Mot de passe associé à la feuille de calcul protégée.

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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

resumeProtection()

Reprend la protection de 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

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

setPassword(password)

Modifie le mot de passe associé à l’objet WorksheetProtection . La définition du mot de passe sous la forme d’une chaîne vide (« ») ou comme null supprime la protection par mot de passe de l’objet WorksheetProtection . La protection de feuille de calcul doit être activée et suspendue pour que cette méthode fonctionne correctement. Si la protection de 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 feuille de calcul est activée et non 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

password: string

Mot de passe associé à l’objet WorksheetProtection .

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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

updateOptions(options)

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

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Paramètres

options: Excel.WorksheetProtectionOptions

Interface d’options associée à l’objet WorksheetProtection .

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Partager via

Excel.WorksheetProtection class

Remarques

Propriétés

Méthodes

Détails de la propriété

allowEditRanges

Valeur de propriété

Remarques

canPauseProtection

Valeur de propriété

Remarques

context

Valeur de propriété

isPasswordProtected

Valeur de propriété

Remarques

isPaused

Valeur de propriété

Remarques

options

Valeur de propriété

Remarques

protected

Valeur de propriété

Remarques

savedOptions

Valeur de propriété

Remarques

Détails de la méthode

checkPassword(password)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

pauseProtection(password)

Paramètres

Retours

Remarques

protect(options, password)

Paramètres

Retours

Remarques

Exemples

resumeProtection()

Retours

Remarques

setPassword(password)

Paramètres

Retours

Remarques

toJSON()

Retours

unprotect(password)

Paramètres

Retours

Remarques

Exemples

updateOptions(options)

Paramètres

Retours

Remarques

Ressources supplémentaires