Excel.AllowEditRange class

Paquet:

excel

Représente un AllowEditRange objet trouvé dans une feuille de calcul. Cet objet fonctionne 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.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Propriétés

address	Spécifie la plage associée à l’objet . 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 à définir la plage.
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 l’objet est protégé par mot de passe.
title	Spécifie le titre de l’objet. 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 à définir le titre. S’il existe déjà un avec AllowEditRange la même chaîne, ou si la chaîne est null ou vide («  »), cette méthode génère une InvalidArgument erreur et ne parvient pas à définir le titre.

Méthodes

delete()	Supprime l’objet du AllowEditRangeCollection. La protection de 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 non suspendue, cette méthode génère une AccessDenied erreur et échoue à l’opération de suppression.
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 pour l’utilisateur dans 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 la protection de feuille de calcul ne peut pas être suspendue, cette méthode génère une UnsupportedOperation erreur et ne parvient pas à suspendre la protection de l’objet. Si le mot de passe est incorrect, cette méthode génère une BadPassword erreur et ne parvient pas à suspendre la protection de l’objet. Si un mot de passe est fourni mais que l’objet ne nécessite pas de mot de passe, le mot de passe entré est ignoré et l’opération réussit.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou 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.
setPassword(password)	Modifie le mot de passe associé à l’objet . Définir la chaîne de mot de passe comme vide («  ») ou null supprimera la protection par mot de passe de l’objet. 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 l’opération set échoue.
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 Excel.AllowEditRange d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.AllowEditRangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

address

Spécifie la plage associée à l’objet . 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 à définir la plage.

address: string;

Valeur de propriété

string

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 l’objet est protégé par mot de passe.

readonly isPasswordProtected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

title

Spécifie le titre de l’objet. 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 à définir le titre. S’il existe déjà un avec AllowEditRange la même chaîne, ou si la chaîne est null ou vide («  »), cette méthode génère une InvalidArgument erreur et ne parvient pas à définir le titre.

title: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Détails de la méthode

delete()

Supprime l’objet du AllowEditRangeCollection. La protection de 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 non suspendue, cette méthode génère une AccessDenied erreur et échoue à l’opération de suppression.

delete(): void;

Retours

void

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.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Paramètres

options

Excel.Interfaces.AllowEditRangeLoadOptions

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

Retours

Excel.AllowEditRange

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

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

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

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

pauseProtection(password)

Suspend la protection de la feuille de calcul pour l’objet pour l’utilisateur dans 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 la protection de feuille de calcul ne peut pas être suspendue, cette méthode génère une UnsupportedOperation erreur et ne parvient pas à suspendre la protection de l’objet. Si le mot de passe est incorrect, cette méthode génère une BadPassword erreur et ne parvient pas à suspendre la protection de l’objet. Si un mot de passe est fourni mais que l’objet ne nécessite pas de mot de passe, le mot de passe entré est ignoré et l’opération réussit.

pauseProtection(password?: string): void;

Paramètres

password

string

Mot de passe associé à l’objet AllowEditRange .

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties

Excel.Interfaces.AllowEditRangeUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.AllowEditRange): void;

Paramètres

properties

Excel.AllowEditRange

Retours

void

setPassword(password)

Modifie le mot de passe associé à l’objet . Définir la chaîne de mot de passe comme vide («  ») ou null supprimera la protection par mot de passe de l’objet. 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 l’opération set échoue.

setPassword(password?: string): void;

Paramètres

password

string

Mot de passe associé à l’objet AllowEditRange .

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

toJSON(): Excel.Interfaces.AllowEditRangeData;

Retours

Excel.Interfaces.AllowEditRangeData