Excel.AllowEditRange class

Paket:: excel

Stellt ein AllowEditRange Objekt dar, das sich in einem Arbeitsblatt befindet. Dieses Objekt funktioniert 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: OfficeExtension.ClientObject

Hinweise

API-Satz: ExcelApiOnline 1.1

Verwendet von

Excel.AllowEditRangeCollection: getItem, getItemAt, getItemOrNullObject, Elemente

Eigenschaften

address	Gibt den Bereich an, der dem Objekt zugeordnet ist. Der Arbeitsblattschutz muss deaktiviert oder angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, gibt diese Methode einen `AccessDenied` Fehler aus und kann den Bereich nicht festlegen.
context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
isPasswordProtected	Gibt an, ob das Objekt kennwortgeschützt ist.
title	Gibt den Titel des Objekts an. Der Arbeitsblattschutz muss deaktiviert oder angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, gibt diese Methode einen `AccessDenied` Fehler aus und kann den Titel nicht festlegen. Wenn bereits ein String mit derselben Zeichenfolge vorhanden `AllowEditRange` ist oder die Zeichenfolge `null` leer ist (""), dann löst diese Methode einen `InvalidArgument` Fehler aus und kann den Titel nicht festlegen.

Methoden

delete()	Löscht das Objekt aus dem `AllowEditRangeCollection`. 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 schlägt beim Löschvorgang fehl.
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 das Objekt für den Benutzer in der aktuellen Sitzung an. Diese Methode bewirkt nichts, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen `UnsupportedOperation` Fehler aus und kann den Schutz für das Objekt nicht anhalten. Wenn das Kennwort falsch ist, gibt diese Methode einen `BadPassword` Fehler aus und kann den Schutz für das Objekt nicht anhalten. Wenn ein Kennwort eingegeben wird, das Objekt jedoch kein Kennwort erfordert, wird das eingegebene Kennwort ignoriert und der Vorgang ist erfolgreich.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
setPassword(password)	Ändert das dem Objekt zugeordnete Kennwort. Wenn Sie die Kennwortzeichenfolge als leer ("") `null` festlegen, oder der Kennwortschutz wird aus dem Objekt entfernt. 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 Festlegen Vorgang schlägt fehl.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche `Excel.AllowEditRange` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `Excel.Interfaces.AllowEditRangeData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

address

Gibt den Bereich an, der dem Objekt zugeordnet ist. Der Arbeitsblattschutz muss deaktiviert oder angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, gibt diese Methode einen AccessDenied Fehler aus und kann den Bereich nicht festlegen.

address: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApiOnline 1.1

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

isPasswordProtected

Gibt an, ob das Objekt kennwortgeschützt ist.

readonly isPasswordProtected: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApiOnline 1.1

title

Gibt den Titel des Objekts an. Der Arbeitsblattschutz muss deaktiviert oder angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, gibt diese Methode einen AccessDenied Fehler aus und kann den Titel nicht festlegen. Wenn bereits ein String mit derselben Zeichenfolge vorhanden AllowEditRange ist oder die Zeichenfolge null leer ist (""), dann löst diese Methode einen InvalidArgument Fehler aus und kann den Titel nicht festlegen.

title: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApiOnline 1.1

Details zur Methode

delete()

Löscht das Objekt aus dem AllowEditRangeCollection. 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 schlägt beim Löschvorgang fehl.

delete(): void;

Gibt zurück

void

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.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Parameter

options: Excel.Interfaces.AllowEditRangeLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Excel.AllowEditRange

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.AllowEditRange

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?: {
            select?: string;
            expand?: string;
        }): Excel.AllowEditRange;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

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

Excel.AllowEditRange

pauseProtection(password)

Hält den Arbeitsblattschutz für das Objekt für den Benutzer in der aktuellen Sitzung an. Diese Methode bewirkt nichts, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen UnsupportedOperation Fehler aus und kann den Schutz für das Objekt nicht anhalten. Wenn das Kennwort falsch ist, gibt diese Methode einen BadPassword Fehler aus und kann den Schutz für das Objekt nicht anhalten. Wenn ein Kennwort eingegeben wird, das Objekt jedoch kein Kennwort erfordert, wird das eingegebene Kennwort ignoriert und der Vorgang ist erfolgreich.

pauseProtection(password?: string): void;

Parameter

password: string

Das dem Objekt zugeordnete AllowEditRange Kennwort.

Gibt zurück

void

Hinweise

API-Satz: ExcelApiOnline 1.1

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.AllowEditRangeUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.AllowEditRange): void;

Parameter

properties: Excel.AllowEditRange

Gibt zurück

void

setPassword(password)

Ändert das dem Objekt zugeordnete Kennwort. Wenn Sie die Kennwortzeichenfolge als leer ("") null festlegen, oder der Kennwortschutz wird aus dem Objekt entfernt. 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 Festlegen Vorgang schlägt fehl.

setPassword(password?: string): void;

Parameter

password: string

Das dem Objekt zugeordnete AllowEditRange Kennwort.

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 sie übergeben wird.) Während das ursprüngliche Excel.AllowEditRange Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.AllowEditRangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.AllowEditRangeData;

Gibt zurück

Excel.Interfaces.AllowEditRangeData

Feedback

War diese Seite hilfreich?