Excel.AllowEditRange class

Paket:

excel

Stellt ein AllowEditRange Objekt dar, das in einem Arbeitsblatt gefunden wurde. Dieses Objekt funktioniert 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

address	Gibt den Bereich an, der dem -Objekt zugeordnet ist. 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 kann den Bereich nicht festlegen.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
isPasswordProtected	Gibt an, ob das Objekt kennwortsicher ist.
title	Gibt den Titel des Objekts an. 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 kann den Titel nicht festlegen. Wenn bereits eine mit derselben Zeichenfolge vorhanden AllowEditRange ist oder die Zeichenfolge leer ist null (""), löst diese Methode einen Fehler aus InvalidArgument und kann den Titel nicht festlegen.

Methoden

delete()	Löscht das -Objekt aus der AllowEditRangeCollection. 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 schlägt den 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 führt keine Aktion aus, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten ist. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen Fehler aus UnsupportedOperation und kann den Schutz für das Objekt nicht anhalten. Wenn das Kennwort falsch ist, löst diese Methode einen Fehler aus BadPassword und kann den Schutz für das Objekt nicht anhalten. Wenn ein Kennwort angegeben wird, aber für das Objekt kein Kennwort erforderlich ist, 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 Kennwort, das dem -Objekt zugeordnet ist. Wenn Sie die Kennwortzeichenfolge als leer ("") oder null festlegen, wird der Kennwortschutz für das Objekt entfernt. 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 Set-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.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.AllowEditRange-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.AllowEditRangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

address

Gibt den Bereich an, der dem -Objekt zugeordnet ist. 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 kann den Bereich nicht festlegen.

address: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

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

isPasswordProtected

Gibt an, ob das Objekt kennwortsicher 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 werden, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen Fehler aus AccessDenied und kann den Titel nicht festlegen. Wenn bereits eine mit derselben Zeichenfolge vorhanden AllowEditRange ist oder die Zeichenfolge leer ist null (""), löst diese Methode einen Fehler aus InvalidArgument 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 der AllowEditRangeCollection. 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 schlägt den 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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

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

pauseProtection(password)

Hält den Arbeitsblattschutz für das Objekt für den Benutzer in der aktuellen Sitzung an. Diese Methode führt keine Aktion aus, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten ist. Wenn der Arbeitsblattschutz nicht angehalten werden kann, löst diese Methode einen Fehler aus UnsupportedOperation und kann den Schutz für das Objekt nicht anhalten. Wenn das Kennwort falsch ist, löst diese Methode einen Fehler aus BadPassword und kann den Schutz für das Objekt nicht anhalten. Wenn ein Kennwort angegeben wird, aber für das Objekt kein Kennwort erforderlich ist, wird das eingegebene Kennwort ignoriert, und der Vorgang ist erfolgreich.

pauseProtection(password?: string): void;

Parameter

password

string

Das Kennwort, das dem AllowEditRange -Objekt zugeordnet ist.

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

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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 Kennwort, das dem -Objekt zugeordnet ist. Wenn Sie die Kennwortzeichenfolge als leer ("") oder null festlegen, wird der Kennwortschutz für das Objekt entfernt. 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 Set-Vorgang schlägt fehl.

setPassword(password?: string): void;

Parameter

password

string

Das Kennwort, das dem AllowEditRange -Objekt zugeordnet ist.

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.AllowEditRange-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.AllowEditRangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.AllowEditRangeData;

Gibt zurück

Excel.Interfaces.AllowEditRangeData