Excel.WorksheetProtection class

Stellt den Schutz eines Arbeitsblattobjekts dar.

Extends

Hinweise

[API-Satz: ExcelApi 1.2 ]

Eigenschaften

allowEditRanges

Gibt die AllowEditRangeCollection in diesem Arbeitsblatt gefundene An.

canPauseProtection

Gibt an, ob der Schutz für dieses Arbeitsblatt angehalten werden kann.

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 Blatt kennwortschützt ist.

isPaused

Gibt an, ob der Arbeitsblattschutz angehalten wird.

options

Gibt die Schutzoptionen für das Arbeitsblatt an.

protected

Gibt an, ob das Arbeitsblatt geschützt ist.

Methoden

checkPassword(password)

Gibt an, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Mit dieser Methode wird der Arbeitsblattschutzstatus nicht geändert.

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 angegebene Arbeitsblattobjekt für den Benutzer in einer bestimmten Sitzung an. Wenn das Kennwort falsch ist, löst diese Methode einen Fehler aus UnsupportedOperation und hält den Schutz nicht an. Mit dieser Methode wird der Schutzstatus nicht geändert, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde.

protect(options, password)

Schützt ein Arbeitsblatt. Schlägt fehl, wenn das Arbeitsblatt bereits geschützt wurde.

resumeProtection()

Setzt den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in einer bestimmten Sitzung fort. Der Arbeitsblattschutz muss angehalten werden, damit diese Methode funktioniert. Wenn der Arbeitsblattschutz nicht angehalten wird, ändert diese Methode den Schutzstatus des Arbeitsblatts nicht.

setPassword(password)

Ändert das dem Objekt zugeordnete WorksheetProtection Kennwort. Durch Festlegen des Kennworts als leere Zeichenfolge ("") oder wie null wird der Kennwortschutz aus dem WorksheetProtection Objekt entfernt. Der Arbeitsblattschutz muss aktiviert und angehalten werden, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz deaktiviert ist, löst diese Methode einen Fehler aus InvalidOperation und kann das Kennwort nicht ändern. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen Fehler aus AccessDenied und ändert das Kennwort nicht.

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während die ursprüngliche Excel. WorksheetProtection-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt zurück (typisiert alsExcel.Interfaces.WorksheetProtectionData), die flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

unprotect(password)

Hebt den Schutz eines Arbeitsblatts auf.

updateOptions(options)

Ändern Sie die Arbeitsblatt-Schutzoptionen, die dem Objekt zugeordnet WorksheetProtection sind. 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 ändert die Arbeitsblattschutzoptionen nicht.

Details zur Eigenschaft

allowEditRanges

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt die AllowEditRangeCollection in diesem Arbeitsblatt gefundene An.

readonly allowEditRanges: Excel.AllowEditRangeCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

canPauseProtection

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Schutz für dieses Arbeitsblatt angehalten werden kann.

readonly canPauseProtection: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

context

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

context: RequestContext;

Eigenschaftswert

isPasswordProtected

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob das Blatt kennwortschützt ist.

readonly isPasswordProtected: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

isPaused

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Arbeitsblattschutz angehalten wird.

readonly isPaused: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

options

Gibt die Schutzoptionen für das Arbeitsblatt an.

readonly options: Excel.WorksheetProtectionOptions;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.2 ]

protected

Gibt an, ob das Arbeitsblatt geschützt ist.

readonly protected: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.2 ]

Details zur Methode

checkPassword(password)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Mit dieser Methode wird der Arbeitsblattschutzstatus nicht geändert.

checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;

Parameter

password

string

Das dem geschützten Arbeitsblatt zugeordnete Kennwort.

Gibt zurück

Gibt true zurück, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Andernfalls wird false.

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

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.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;

Parameter

options
Excel.Interfaces.WorksheetProtectionLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

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

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

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

pauseProtection(password)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Hält den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in einer bestimmten Sitzung an. Wenn das Kennwort falsch ist, löst diese Methode einen Fehler aus UnsupportedOperation und hält den Schutz nicht an. Mit dieser Methode wird der Schutzstatus nicht geändert, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde.

pauseProtection(password?: string): void;

Parameter

password

string

Das dem geschützten Arbeitsblatt zugeordnete Kennwort.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

protect(options, password)

Schützt ein Arbeitsblatt. Schlägt fehl, wenn das Arbeitsblatt bereits geschützt wurde.

protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;

Parameter

options
Excel.WorksheetProtectionOptions

Optional. Optionen für den Arbeitsblattschutz.

password

string

Optional. Blattschutzkennwort.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2 für Optionen; 1.7 für Kennwort ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.load("protection/protected");

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect();
    }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.load("protection/protected");

    await context.sync();

    if (!activeSheet.protection.protected) {
        activeSheet.protection.protect(null, password);
    }
});

resumeProtection()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Setzt den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in einer bestimmten Sitzung fort. Der Arbeitsblattschutz muss angehalten werden, damit diese Methode funktioniert. Wenn der Arbeitsblattschutz nicht angehalten wird, ändert diese Methode den Schutzstatus des Arbeitsblatts nicht.

resumeProtection(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

setPassword(password)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ändert das dem Objekt zugeordnete WorksheetProtection Kennwort. Durch Festlegen des Kennworts als leere Zeichenfolge ("") oder wie null wird der Kennwortschutz aus dem WorksheetProtection Objekt entfernt. Der Arbeitsblattschutz muss aktiviert und angehalten werden, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz deaktiviert ist, löst diese Methode einen Fehler aus InvalidOperation und kann das Kennwort nicht ändern. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, löst diese Methode einen Fehler aus AccessDenied und ändert das Kennwort nicht.

setPassword(password?: string): void;

Parameter

password

string

Das dem Objekt zugeordnete WorksheetProtection Kennwort.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während die ursprüngliche Excel. WorksheetProtection-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt zurück (typisiert alsExcel.Interfaces.WorksheetProtectionData), die flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.WorksheetProtectionData;

Gibt zurück

unprotect(password)

Hebt den Schutz eines Arbeitsblatts auf.

unprotect(password?: string): void;

Parameter

password

string

Blattschutzkennwort.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.7 für Kennwort ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect();
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
    let activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.protection.unprotect(password);
});

updateOptions(options)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ändern Sie die Arbeitsblatt-Schutzoptionen, die dem Objekt zugeordnet WorksheetProtection sind. 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 ändert die Arbeitsblattschutzoptionen nicht.

updateOptions(options: Excel.WorksheetProtectionOptions): void;

Parameter

options
Excel.WorksheetProtectionOptions

Die dem Objekt zugeordnete WorksheetProtection Optionsschnittstelle.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi BETA (NUR VORSCHAU) ]