Excel.AllowEditRangeCollection 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 l’ensemble AllowEditRange
d’objets trouvés dans une feuille de calcul. AllowEditRange
fonctionnent 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
context | Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte. |
items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
add(title, range |
Ajoute un |
get |
Renvoie le nombre |
get |
Obtient |
get |
Renvoie un |
get |
Obtient |
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 |
Suspend la protection de feuille de calcul pour tous les objets de la collection qui ont le mot de passe donné pour l’utilisateur |
toJSON() | Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet |
Détails de la propriété
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é
items
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.
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)
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.
Ajoute un AllowEditRange
objet à la collection. 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 d’ajout échoue.
add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;
Paramètres
- title
-
string
Chaîne de titre de AllowEditRange
l’objet à ajouter.
- rangeAddress
-
string
Adresse de plage de AllowEditRange
l’objet à ajouter.
- options
- Excel.AllowEditRangeOptions
Options supplémentaires à ajouter à AllowEditRange
l’objet, telles que le mot de passe.
Retours
void
Remarques
[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]
getCount()
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.
Renvoie le nombre AllowEditRange
d’objets de la collection.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Remarques
[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]
getItem(key)
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.
Obtient AllowEditRange
l’objet par son titre.
getItem(key: string): Excel.AllowEditRange;
Paramètres
- key
-
string
Le titre de l' AllowEditRange
.
Retours
Avec AllowEditRange
le titre. S’il n’y a pas de titre AllowEditRange
donné, une ItemNotFound
erreur est lancée.
Remarques
[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]
getItemAt(index)
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.
Renvoie un AllowEditRange
objet par son index dans la collection.
getItemAt(index: number): Excel.AllowEditRange;
Paramètres
- index
-
number
Index de AllowEditRange
l’objet dans la collection.
Retours
Au AllowEditRange
niveau de l’index donné.
Remarques
[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]
getItemOrNullObject(key)
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.
Obtient AllowEditRange
l’objet par son titre.
getItemOrNullObject(key: string): Excel.AllowEditRange;
Paramètres
- key
-
string
Le titre de l' AllowEditRange
.
Retours
Avec AllowEditRange
le titre. Si le titre donné n’existe pas, cette méthode renvoie un objet AllowEditRange
dont la propriété est définie isNullObject
sur true
. Pour plus d’informations, * voir méthodes et propriétés OrNullObject.
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.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;
Paramètres
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.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)
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?: 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 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 tous les objets de la collection qui ont le mot de passe donné pour l’utilisateur AllowEditRange
dans une session donnée. Cette méthode interrompt uniquement la protection des objets si la protection de feuille de calcul est activée AllowEditRange
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 ne correspond à aucun objet de la collection, cette méthode envoie une erreur et ne parvient pas à suspendre la protection de n’importe quelle plage AllowEditRange
BadPassword
de la collection.
pauseProtection(password: string): void;
Paramètres
- password
-
string
Mot de passe pour suspendre la protection AllowEditRange
sur les objets.
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.) Alors que Excel.AllowEditRangeCollection
l’objet d’origine est un objet API, la méthode renvoie un objet toJSON
JavaScript simple (tapé sous la forme Excel.Interfaces.AllowEditRangeCollectionData
) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;