Excel.WorksheetProtection class

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

Extends

Remarques

[Ensemble d’API : ExcelApi 1.2 ]

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, AllowEditRange un 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 demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

isPasswordProtected

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

isPaused

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

options

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

protected

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

savedOptions

Spécifie les paramètres des options de protection enregistrés dans la feuille de calcul. Cela retourne le même objet quel WorksheetProtectionOptions 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.

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 feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur dans une session donnée. Si le mot de passe est incorrect, cette méthode envoie une UnsupportedOperation 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 feuille de calcul doit être suspendue pour que cette méthode fonctionne. Si la protection de 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 . Définir le mot de passe comme une chaîne vide («  ») ou supprimera null 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 InvalidOperation envoie une erreur et ne parvient pas à modifier le mot de passe. Si la protection de feuille de calcul est activée et non suspendue, AccessDenied cette méthode envoie une 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 transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est transmis.) Tandis que la Excel. Objet WorksheetProtection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetProtectionData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir 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, AccessDenied cette méthode envoie une erreur et ne parvient pas à modifier les options de protection de la feuille de calcul.

Détails de la propriété

allowEditRanges

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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, AllowEditRange un 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é

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

canPauseProtection

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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 : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

isPasswordProtected

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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 : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

isPaused

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

readonly isPaused: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

options

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

readonly options: Excel.WorksheetProtectionOptions;

Valeur de propriété

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

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie les paramètres des options de protection enregistrés dans la feuille de calcul. Cela retourne le même objet quel WorksheetProtectionOptions que soit l’état de protection de la feuille de calcul.

readonly savedOptions: Excel.WorksheetProtectionOptions;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

Détails de la méthode

checkPassword(password)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.

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

Paramètres

password

string

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

Retours

Renvoie si true le mot de passe peut être utilisé pour déverrouiller la protection de feuille de calcul. Dans le cas contraire, renvoie false.

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

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 lesquelles les propriétés de l’objet à charger.

Retours

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 spécifiant les propriétés à charger.

Retours

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, propertyNamesAndPaths.expand et est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

pauseProtection(password)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Suspend la protection de feuille de calcul pour l’objet de feuille de calcul donné pour l’utilisateur dans une session donnée. Si le mot de passe est incorrect, cette méthode envoie une UnsupportedOperation 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 : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

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

Facultatif. Options de protection de feuille.

password

string

Facultatif. 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
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();
    }
});
// 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()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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 feuille de calcul doit être suspendue pour que cette méthode fonctionne. Si la protection de 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 : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

setPassword(password)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Modifie le mot de passe associé à l’objet WorksheetProtection . Définir le mot de passe comme une chaîne vide («  ») ou supprimera null 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 InvalidOperation envoie une erreur et ne parvient pas à modifier le mot de passe. Si la protection de feuille de calcul est activée et non suspendue, AccessDenied cette méthode envoie une 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 : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est transmis.) Tandis que la Excel. Objet WorksheetProtection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetProtectionData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Retours

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 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
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect();
});
// 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)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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, AccessDenied cette méthode envoie une erreur et ne parvient pas à modifier les options de protection de la feuille de calcul.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Paramètres

options
Excel.WorksheetProtectionOptions

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

Retours

void

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]