Excel.AllowEditRangeCollection class
Représente l’ensemble des objets trouvés dans une feuille de AllowEditRange calcul.
AllowEditRange Les objets fonctionnent avec les propriétés de protection de la feuille de calcul. Lorsque la protection de la feuille de calcul est activée, un AllowEditRange objet peut être utilisé pour autoriser la modification d’une plage spécifique, tout en conservant la protection sur le reste de la feuille de calcul.
- Extends
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. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(title, range |
Ajoute un |
| get |
Renvoie le nombre d’objets |
| get |
Récupère l’objet |
| get |
Renvoie un |
| get |
Récupère l’objet |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| pause |
Interrompt la protection de la feuille de calcul pour tous les |
| toJSON() | Remplace la méthode JavaScript |
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.AllowEditRange[];Valeur de propriété
Détails de la méthode
add(title, rangeAddress, options)
Ajoute un AllowEditRange objet à la feuille de calcul. La protection de la 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 n’est pas suspendue, cette méthode génère une AccessDenied erreur et l’opération d’ajout échoue.
add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;Paramètres
- title
-
string
Chaîne de titre de l’objet AllowEditRange à ajouter.
- rangeAddress
-
string
Adresse de plage de l’objet AllowEditRange à ajouter.
- options
- Excel.AllowEditRangeOptions
Options supplémentaires à ajouter à l’objet AllowEditRange , comme le mot de passe.
Retours
void
Remarques
getCount()
Renvoie le nombre d’objets AllowEditRange dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Récupère l’objet AllowEditRange par son titre.
getItem(key: string): Excel.AllowEditRange;Paramètres
- key
-
string
Titre du AllowEditRangefichier .
Retours
Le AllowEditRange avec le titre. S’il n’y a pas AllowEditRange de titre donné, une ItemNotFound erreur est générée.
Remarques
getItemAt(index)
Renvoie un AllowEditRange objet par son index dans la collection.
getItemAt(index: number): Excel.AllowEditRange;Paramètres
- index
-
number
Index de l’objet AllowEditRange de la collection.
Retours
Le AllowEditRange à l’index donné.
Remarques
getItemOrNullObject(key)
Récupère l’objet AllowEditRange par son titre.
getItemOrNullObject(key: string): Excel.AllowEditRange;Paramètres
- key
-
string
Titre du AllowEditRangefichier .
Retours
Le AllowEditRange avec le titre. Si le titre donné n’a pas AllowEditRange de valeur, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
Remarques
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.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;Paramètres
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Fournit des options pour 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.AllowEditRangeCollection;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?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
pauseProtection(password)
Interrompt la protection de la feuille de calcul pour tous les AllowEditRange objets trouvés dans cette feuille de calcul qui ont le mot de passe donné pour l’utilisateur dans la session active. Cette méthode ne fait rien si la protection de la feuille de calcul n’est pas activée ou est suspendue. Si la protection de la feuille de calcul ne peut pas être suspendue, cette méthode génère une UnsupportedOperation erreur et ne suspend pas la protection de la plage. Si le mot de passe ne correspond à aucun AllowEditRange objet de la collection, cette méthode génère une BadPassword erreur et ne suspend pas la protection pour une plage de la collection.
pauseProtection(password: string): void;Paramètres
- password
-
string
Mot de passe pour suspendre la protection sur les AllowEditRange objets.
Retours
void
Remarques
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.AllowEditRangeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.AllowEditRangeCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;