Excel.AllowEditRangeCollection class

Paket:

excel

Stellt den Satz von AllowEditRange Objekten dar, die 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 zu ermöglichen, während der Schutz für den Rest des Arbeitsblatts beibehalten wird.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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, rangeAddress, options)	Fügt dem Arbeitsblatt ein -Objekt hinzu AllowEditRange . Der Arbeitsblattschutz muss deaktiviert oder angehalten werden, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen Fehler aus AccessDenied , und der Add-Vorgang schlägt fehl.
getCount()	Gibt die Anzahl der AllowEditRange Objekte in der Auflistung zurück.
getItem(key)	Ruft das AllowEditRange -Objekt anhand seines Titels ab.
getItemAt(index)	Gibt ein AllowEditRange Objekt anhand seines Indexes in der Auflistung zurück.
getItemOrNullObject(key)	Ruft das AllowEditRange -Objekt anhand seines Titels ab.
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(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(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.
pauseProtection(password)	Hält den Arbeitsblattschutz für alle AllowEditRange Objekte in diesem Arbeitsblatt an, die über das für den Benutzer in der aktuellen Sitzung angegebene Kennwort verfügen. Diese Methode führt keine Aktion aus, wenn der Arbeitsblattschutz nicht aktiviert oder angehalten ist. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen Fehler aus UnsupportedOperation und kann den Schutz für den Bereich nicht anhalten. Wenn das Kennwort mit keinem AllowEditRange Objekt in der Auflistung übereinstimmt, löst diese Methode einen Fehler aus BadPassword und kann den Schutz für einen Bereich in der Auflistung nicht anhalten.
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 das Objekt ü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 Auflistung enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.AllowEditRange[];

Eigenschaftswert

Excel.AllowEditRange[]

Details zur Methode

add(title, rangeAddress, options)

Fügt dem Arbeitsblatt ein -Objekt hinzu AllowEditRange . Der Arbeitsblattschutz muss deaktiviert oder angehalten werden, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen Fehler aus AccessDenied , 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 sollen, z. B. das Kennwort.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

getCount()

Gibt die Anzahl der AllowEditRange Objekte in der Auflistung zurück.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

getItem(key)

Ruft das AllowEditRange -Objekt anhand seines Titels ab.

getItem(key: string): Excel.AllowEditRange;

Parameter

key

string

Der Titel des AllowEditRange.

Gibt zurück

Excel.AllowEditRange

Der AllowEditRange mit dem Titel. Wenn mit dem angegebenen Titel kein AllowEditRange vorhanden ist, wird ein ItemNotFound Fehler ausgelöst.

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

getItemAt(index)

Gibt ein AllowEditRange Objekt anhand seines Indexes in der Auflistung zurück.

getItemAt(index: number): Excel.AllowEditRange;

Parameter

index

number

Der Index des AllowEditRange -Objekts in der Auflistung.

Gibt zurück

Excel.AllowEditRange

Die AllowEditRange am angegebenen Index.

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Ruft das AllowEditRange -Objekt anhand seines Titels ab.

getItemOrNullObject(key: string): Excel.AllowEditRange;

Parameter

key

string

Der Titel des AllowEditRange.

Gibt zurück

Excel.AllowEditRange

Der AllowEditRange mit dem Titel. Wenn kein AllowEditRange mit dem angegebenen Titel vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.AllowEditRangeCollection

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

Excel.AllowEditRangeCollection

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 Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.AllowEditRangeCollection

pauseProtection(password)

Hält den Arbeitsblattschutz für alle AllowEditRange Objekte in diesem Arbeitsblatt an, die über das für den Benutzer in der aktuellen Sitzung angegebene Kennwort verfügen. Diese Methode führt keine Aktion aus, wenn der Arbeitsblattschutz nicht aktiviert oder angehalten ist. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen Fehler aus UnsupportedOperation und kann den Schutz für den Bereich nicht anhalten. Wenn das Kennwort mit keinem AllowEditRange Objekt in der Auflistung übereinstimmt, löst diese Methode einen Fehler aus BadPassword und kann den Schutz für einen Bereich in der Auflistung nicht anhalten.

pauseProtection(password: string): void;

Parameter

password

string

Das Kennwort zum Anhalten des Schutzes für die AllowEditRange Objekte.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

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 das Objekt ü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 Auflistung enthält.

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

Gibt zurück

Excel.Interfaces.AllowEditRangeCollectionData