Excel.WorksheetProtection class
Stellt den Schutz eines Arbeitsblattobjekts dar.
- Extends
Hinweise
Eigenschaften
| allow |
Gibt das |
| can |
Gibt an, ob der Schutz für dieses Arbeitsblatt angehalten werden kann. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| is |
Gibt an, ob das Blatt kennwortsicher ist. |
| is |
Gibt an, ob der Arbeitsblattschutz angehalten ist. |
| options | Gibt die Schutzoptionen für das Arbeitsblatt an. |
| protected | Gibt an, ob das Arbeitsblatt geschützt ist. |
| saved |
Gibt die im Arbeitsblatt gespeicherten Schutzoptionen an. Dadurch wird unabhängig vom Schutzstatus des Arbeitsblatts dasselbe |
Methoden
| check |
Gibt an, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Diese Methode ändert den Schutzstatus des Arbeitsblatts nicht. Wenn ein Kennwort eingegeben wird, aber kein Kennwort zum Entsperren des Arbeitsblattschutzes erforderlich ist, gibt diese Methode false zurück. |
| 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 das angegebene Arbeitsblattobjekt 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 das Kennwort falsch ist, löst diese Methode einen Fehler aus |
| protect(options, password) | Schützt ein Arbeitsblatt. Schlägt fehl, wenn das Arbeitsblatt bereits geschützt wurde. |
| resume |
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. |
| set |
Ändert das Kennwort, das dem |
| toJSON() | Überschreibt die JavaScript-Methode |
| unprotect(password) | Hebt den Schutz eines Arbeitsblatts auf. |
| update |
Ändern Sie die dem -Objekt zugeordneten |
Details zur Eigenschaft
allowEditRanges
Gibt das AllowEditRangeCollection in diesem Arbeitsblatt gefundene Objekt an. Dies ist eine Auflistung von AllowEditRange -Objekten, die mit Arbeitsblattschutzeigenschaften funktionieren. 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.
readonly allowEditRanges: Excel.AllowEditRangeCollection;Eigenschaftswert
Hinweise
canPauseProtection
Gibt an, ob der Schutz für dieses Arbeitsblatt angehalten werden kann.
readonly canPauseProtection: boolean;Eigenschaftswert
boolean
Hinweise
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
isPasswordProtected
Gibt an, ob das Blatt kennwortsicher ist.
readonly isPasswordProtected: boolean;Eigenschaftswert
boolean
Hinweise
isPaused
Gibt an, ob der Arbeitsblattschutz angehalten ist.
readonly isPaused: boolean;Eigenschaftswert
boolean
Hinweise
options
Gibt die Schutzoptionen für das Arbeitsblatt an.
readonly options: Excel.WorksheetProtectionOptions;Eigenschaftswert
Hinweise
protected
Gibt an, ob das Arbeitsblatt geschützt ist.
readonly protected: boolean;Eigenschaftswert
boolean
Hinweise
savedOptions
Gibt die im Arbeitsblatt gespeicherten Schutzoptionen an. Dadurch wird unabhängig vom Schutzstatus des Arbeitsblatts dasselbe WorksheetProtectionOptions Objekt zurückgegeben.
readonly savedOptions: Excel.WorksheetProtectionOptions;Eigenschaftswert
Hinweise
Details zur Methode
checkPassword(password)
Gibt an, ob das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Diese Methode ändert den Schutzstatus des Arbeitsblatts nicht. Wenn ein Kennwort eingegeben wird, aber kein Kennwort zum Entsperren des Arbeitsblattschutzes erforderlich ist, gibt diese Methode false zurück.
checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;Parameter
- password
-
string
Das Kennwort, das anhand des geschützten Arbeitsblatts überprüft werden soll.
Gibt zurück
OfficeExtension.ClientResult<boolean>
Gibt zurück true , wenn das Kennwort zum Entsperren des Arbeitsblattschutzes verwendet werden kann. Andernfalls wird zurückgegeben false.
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.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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)
Hält den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt 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 das Kennwort falsch ist, löst diese Methode einen Fehler aus InvalidArgument und kann den Schutz nicht anhalten. Diese Methode ändert den Schutzstatus nicht, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten ist.
pauseProtection(password?: string): void;Parameter
- password
-
string
Das Kennwort, das dem geschützten Arbeitsblatt zugeordnet ist.
Gibt zurück
void
Hinweise
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
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()
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
setPassword(password)
Ändert das Kennwort, das dem WorksheetProtection -Objekt zugeordnet ist. Wenn Sie das Kennwort als leere Zeichenfolge ("") oder als festlegen null , wird der Kennwortschutz für das 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 kann das Kennwort nicht ändern.
setPassword(password?: string): void;Parameter
- password
-
string
Das Kennwort, das dem WorksheetProtection -Objekt zugeordnet ist.
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 das Objekt übergeben wird.) Während das ursprüngliche Excel.WorksheetProtection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorksheetProtectionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
let activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.protection.unprotect(password);
});
updateOptions(options)
Ändern Sie die dem -Objekt zugeordneten WorksheetProtection Arbeitsblattschutzoptionen. 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 die Arbeitsblattschutzoptionen nicht ändern.
updateOptions(options: Excel.WorksheetProtectionOptions): void;Parameter
- options
- Excel.WorksheetProtectionOptions
Die options-Schnittstelle, die dem WorksheetProtection -Objekt zugeordnet ist.
Gibt zurück
void
Hinweise
Office Add-ins