Excel.FormatProtection class

Paquet:
excel

Représente la protection du format d’un objet plage.

Extends
OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.2

Utilisateur

Propriétés

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
formulaHidden

Indique si Excel masque la formule des cellules de la plage. Une null valeur indique que toute la plage n’a pas de paramètre de formule uniforme masquée.
locked

Spécifie si Excel verrouille les cellules dans l’objet. Une null valeur indique que toute la plage ne dispose pas d’un paramètre de verrouillage uniforme.

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.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

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

Détails de la propriété

context

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é

Excel.RequestContext

formulaHidden

Indique si Excel masque la formule des cellules de la plage. Une null valeur indique que toute la plage n’a pas de paramètre de formule uniforme masquée.

formulaHidden: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.2

locked

Spécifie si Excel verrouille les cellules dans l’objet. Une null valeur indique que toute la plage ne dispose pas d’un paramètre de verrouillage uniforme.

locked: boolean;

Valeur de propriété

boolean

Remarques

Jeu 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.FormatProtectionLoadOptions): Excel.FormatProtection;

Paramètres

options
Excel.Interfaces.FormatProtectionLoadOptions

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

Retours

Excel.FormatProtection

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

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

Excel.FormatProtection

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

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.FormatProtectionUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.FormatProtectionUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.FormatProtection): void;

Paramètres

properties
Excel.FormatProtection

Retours

void

toJSON()

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

toJSON(): Excel.Interfaces.FormatProtectionData;

Retours

Excel.Interfaces.FormatProtectionData