ExcelScript.AllowEditRange interface

Colis:

ExcelScript

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.

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.
getAddress()	Spécifie la plage associée à l’objet .
getIsPasswordProtected()	Spécifie si l’objet est protégé par mot de passe.
getTitle()	Spécifie le titre de l’objet.
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.
setAddress(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.
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 la feuille de calcul est activée et non suspendue, cette méthode génère une AccessDenied erreur et l’opération set échoue.
setTitle(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.

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;

Retourne

void

getAddress()

Spécifie la plage associée à l’objet .

getAddress(): string;

Retourne

string

getIsPasswordProtected()

Spécifie si l’objet est protégé par mot de passe.

getIsPasswordProtected(): boolean;

Retourne

boolean

getTitle()

Spécifie le titre de l’objet.

getTitle(): string;

Retourne

string

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 .

Retourne

void

setAddress(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.

setAddress(address: string): void;

Paramètres

address

string

Retourne

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

Retourne

void

setTitle(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.

setTitle(title: string): void;

Paramètres

title

string

Retourne

void