Excel.AllowEditRange class

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.

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 objet peut être utilisé pour permettre la modification d’une plage spécifique, tout en conservant la protection sur le AllowEditRange reste de la feuille de calcul.

Extends

Remarques

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

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 envoie une erreur et ne parvient pas AccessDenied à définir la plage.

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 le mot AllowEditRange de passe est protégé.

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 envoie une erreur et ne parvient pas AccessDenied à définir le titre. S’il existe déjà une chaîne avec la même chaîne, ou si la chaîne est ou vide («  »), cette méthode envoie une erreur et ne parvient pas à définir AllowEditRange null le InvalidArgument titre.

Méthodes

delete()

Supprime cet objet de l’objet 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 feuille de calcul est activée et non suspendue, cette méthode envoie une erreur AccessDenied 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 feuille de calcul pour AllowEditRange l’objet donné pour l’utilisateur dans une session donnée. Cette méthode interrompt uniquement la protection de l’objet si la protection de feuille de calcul AllowEditRange est activée et non suspendue. Si la protection de feuille de calcul ne peut pas être suspendue, cette méthode envoie une erreur et ne parvient pas à UnsupportedOperation suspendre la protection de la plage. Si le mot de passe est incorrect, cette méthode envoie une erreur et ne parvient pas à InvalidArgument suspendre la protection de la plage.

set(properties, options)

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

set(properties)

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

setPassword(password)

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

toJSON()

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

Détails de la propriété

address

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 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 envoie une erreur et ne parvient pas AccessDenied à définir la plage.

address: string;

Valeur de propriété

string

Remarques

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

context

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.

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 le mot AllowEditRange de passe est protégé.

readonly isPasswordProtected: boolean;

Valeur de propriété

boolean

Remarques

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

title

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 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 envoie une erreur et ne parvient pas AccessDenied à définir le titre. S’il existe déjà une chaîne avec la même chaîne, ou si la chaîne est ou vide («  »), cette méthode envoie une erreur et ne parvient pas à définir AllowEditRange null le InvalidArgument titre.

title: string;

Valeur de propriété

string

Remarques

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

Détails de la méthode

delete()

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.

Supprime cet objet de l’objet 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 feuille de calcul est activée et non suspendue, cette méthode envoie une erreur AccessDenied et échoue à l’opération de suppression.

delete(): void;

Retours

void

Remarques

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

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

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

Retours

load(propertyNames)

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.

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

Retours

load(propertyNamesAndPaths)

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.

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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand 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 AllowEditRange l’objet donné pour l’utilisateur dans une session donnée. Cette méthode interrompt uniquement la protection de l’objet si la protection de feuille de calcul AllowEditRange est activée et non suspendue. Si la protection de feuille de calcul ne peut pas être suspendue, cette méthode envoie une erreur et ne parvient pas à UnsupportedOperation suspendre la protection de la plage. Si le mot de passe est incorrect, cette méthode envoie une erreur et ne parvient pas à InvalidArgument suspendre la protection de la plage.

pauseProtection(password?: string): void;

Paramètres

password

string

Mot de passe associé à AllowEditRange l’objet.

Retours

void

Remarques

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

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

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple 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 structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

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

Retours

void

set(properties)

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.

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

set(properties: Excel.AllowEditRange): void;

Paramètres

Retours

void

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é au AllowEditRange. Définir la chaîne de mot de passe comme vide («  ») ou null supprimera la protection par mot de passe de la AllowEditRange. 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 envoie une erreur et AccessDenied l’opération set échoue.

setPassword(password?: string): void;

Paramètres

password

string

Mot de passe associé à AllowEditRange l’objet.

Retours

void

Remarques

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

toJSON()

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.

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

toJSON(): Excel.Interfaces.AllowEditRangeData;

Retours