Excel.AllowEditRangeCollection class
Stellt die Gruppe von Objekten dar, die AllowEditRange in einem Arbeitsblatt gefunden werden.
AllowEditRange -Objekte arbeiten mit Arbeitsblattschutzeigenschaften. Wenn der Arbeitsblattschutz aktiviert ist, kann ein AllowEditRange Objekt verwendet werden, um die Bearbeitung eines bestimmten Bereichs zuzulassen, während der Rest des Arbeitsblatts geschützt bleibt.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(title, range |
Fügt dem Arbeitsblatt ein |
| get |
Gibt die Anzahl der |
| get |
Ruft das |
| get |
Gibt ein |
| get |
Ruft das |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| pause |
Hält den Arbeitsblattschutz für alle |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.AllowEditRange[];Eigenschaftswert
Details zur Methode
add(title, rangeAddress, options)
Fügt dem Arbeitsblatt ein AllowEditRange Objekt hinzu. Der Arbeitsblattschutz muss deaktiviert oder angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen AccessDenied Fehler aus, und der Add-Vorgang schlägt fehl.
add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;Parameter
- title
-
string
Die Titelzeichenfolge des AllowEditRange hinzuzufügenden Objekts.
- rangeAddress
-
string
Die Bereichsadresse des AllowEditRange hinzuzufügenden Objekts.
- options
- Excel.AllowEditRangeOptions
Zusätzliche Optionen, die dem AllowEditRange Objekt hinzugefügt werden können, z. B. das Kennwort.
Gibt zurück
void
Hinweise
getCount()
Gibt die Anzahl der AllowEditRange Objekte in der Sammlung zurück.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(key)
Ruft das AllowEditRange Objekt anhand seines Titels ab.
getItem(key: string): Excel.AllowEditRange;Parameter
- key
-
string
Der Titel der AllowEditRange.
Gibt zurück
Die AllowEditRange mit dem Titel. Wenn mit dem angegebenen Titel kein vorhanden AllowEditRange ist, wird ein ItemNotFound Fehler ausgelöst.
Hinweise
getItemAt(index)
Gibt ein AllowEditRange Objekt anhand seines Index in der Auflistung zurück.
getItemAt(index: number): Excel.AllowEditRange;Parameter
- index
-
number
Der Index des Objekts AllowEditRange in der Sammlung.
Gibt zurück
Die AllowEditRange am angegebenen Index.
Hinweise
getItemOrNullObject(key)
Ruft das AllowEditRange Objekt anhand seines Titels ab.
getItemOrNullObject(key: string): Excel.AllowEditRange;Parameter
- key
-
string
Der Titel der AllowEditRange.
Gibt zurück
Die AllowEditRange mit dem Titel. Wenn mit dem angegebenen Titel kein vorhanden AllowEditRange ist, gibt diese Methode ein Objekt mit seiner isNullObject Eigenschaft auf truezurück. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;Parameter
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.AllowEditRangeCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
pauseProtection(password)
Hält den Arbeitsblattschutz für alle AllowEditRange auf diesem Arbeitsblatt gefundenen Objekte an, die das angegebene Kennwort für den Benutzer in der aktuellen Sitzung aufweisen. Diese Methode bewirkt nichts, wenn der Arbeitsblattschutz nicht aktiviert oder angehalten ist. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen UnsupportedOperation Fehler aus und kann den Schutz für den Bereich nicht anhalten. Wenn das Kennwort mit keinem AllowEditRange Objekt in der Auflistung übereinstimmt, dann löst diese Methode einen BadPassword Fehler aus und kann den Schutz für keinen Bereich in der Auflistung anhalten.
pauseProtection(password: string): void;Parameter
- password
-
string
Das Kennwort, um den Schutz der AllowEditRange Objekte anzuhalten.
Gibt zurück
void
Hinweise
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.AllowEditRangeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.AllowEditRangeCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;