Excel.AllowEditRangeCollection class

  • Référence
Paquet:
excel

Représente l’ensemble d’objets AllowEditRange trouvés dans une feuille de calcul. AllowEditRange les objets fonctionnent 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

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(title, rangeAddress, options)

Ajoute un AllowEditRange objet à la feuille de calcul. 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 d’ajout échoue.
getCount()

Retourne le nombre d’objets dans AllowEditRange la collection.
getItem(key)

Obtient l’objet AllowEditRange par son titre.
getItemAt(index)

Retourne un AllowEditRange objet en fonction de son index dans la collection.
getItemOrNullObject(key)

Obtient l’objet AllowEditRange par son titre.
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 tous les AllowEditRange objets de cette feuille de calcul qui ont le mot de passe donné à 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 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 parvient pas à suspendre 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 parvient pas à suspendre la protection des plages de la collection.
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 d’origine Excel.AllowEditRangeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.AllowEditRangeCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

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

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.AllowEditRange[];

Valeur de propriété

Excel.AllowEditRange[]

Détails de la méthode

add(title, rangeAddress, options)

Ajoute un AllowEditRange objet à la feuille de calcul. 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 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 , telles que le mot de passe.

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getCount()

Retourne le nombre d’objets dans AllowEditRange la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getItem(key)

Obtient l’objet AllowEditRange par son titre.

getItem(key: string): Excel.AllowEditRange;

Paramètres

key

string

Titre de .AllowEditRange

Retours

Excel.AllowEditRange

AllowEditRange avec le titre. S’il n’y a pas AllowEditRange avec le titre donné, une ItemNotFound erreur est générée.

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getItemAt(index)

Retourne un AllowEditRange objet en fonction de son index dans la collection.

getItemAt(index: number): Excel.AllowEditRange;

Paramètres

index

number

Index de l’objet AllowEditRange dans la collection.

Retours

Excel.AllowEditRange

au AllowEditRange niveau de l’index donné.

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtient l’objet AllowEditRange par son titre.

getItemOrNullObject(key: string): Excel.AllowEditRange;

Paramètres

key

string

Titre de .AllowEditRange

Retours

Excel.AllowEditRange

AllowEditRange avec le titre. S’il n’y a pas AllowEditRange avec le titre donné, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

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

Excel.AllowEditRangeCollection

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

Retours

Excel.AllowEditRangeCollection

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

Excel.AllowEditRangeCollection

pauseProtection(password)

Suspend la protection de la feuille de calcul pour tous les AllowEditRange objets de cette feuille de calcul qui ont le mot de passe donné à 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 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 parvient pas à suspendre 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 parvient pas à suspendre la protection des plages 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

[ 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 d’origine Excel.AllowEditRangeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.AllowEditRangeCollectionDataque ) qui 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;

Retours

Excel.Interfaces.AllowEditRangeCollectionData