Excel.WorksheetProtection class
Stellt den Schutz eines Arbeitsblattobjekts dar.
- Extends
Eigenschaften
| allow |
Gibt das in diesem Arbeitsblatt gefundene |
| can |
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. |
| is |
Gibt an, ob das Blatt kennwortgeschützt 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. Mit dieser Methode wird der Schutzzustand des Arbeitsblatts nicht geändert. 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 bewirkt nichts, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde. Wenn das Kennwort falsch ist, löst diese Methode einen |
| protect(options, password) | Schützt ein Arbeitsblatt. Fehler, 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 dem Objekt zugeordnete |
| toJSON() | Überschreibt die JavaScript-Methode |
| unprotect(password) | Hebt den Schutz eines Arbeitsblatts auf. |
| update |
Ändern Sie die dem |
Details zur Eigenschaft
allowEditRanges
Gibt das in diesem Arbeitsblatt gefundene AllowEditRangeCollection Objekt an. Dies ist eine Sammlung von AllowEditRange Objekten, die mit Arbeitsblattschutzeigenschaften arbeiten. 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.
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 dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
isPasswordProtected
Gibt an, ob das Blatt kennwortgeschützt 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. Mit dieser Methode wird der Schutzzustand des Arbeitsblatts nicht geändert. 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 mit dem geschützten Arbeitsblatt abgeglichen werden soll.
Gibt zurück
OfficeExtension.ClientResult<boolean>
Gibt zurück true , ob 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 für die zu ladenden Eigenschaften des Objekts bereit.
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 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
pauseProtection(password)
Hält den Arbeitsblattschutz für das angegebene Arbeitsblattobjekt für den Benutzer in der aktuellen Sitzung an. Diese Methode bewirkt nichts, wenn der Arbeitsblattschutz nicht aktiviert oder bereits angehalten wurde. Wenn das Kennwort falsch ist, löst diese Methode einen InvalidArgument Fehler aus 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 dem geschützten Arbeitsblatt zugeordnete Kennwort.
Gibt zurück
void
Hinweise
protect(options, password)
Schützt ein Arbeitsblatt. Fehler, 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. Kennwort für Arbeitsblattschutz.
Gibt zurück
void
Hinweise
API-Satz: ExcelApi 1.2 für Optionen; 1.7 für Passwort
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 dem Objekt zugeordnete WorksheetProtection Kennwort. Wenn Sie das Kennwort als leere Zeichenfolge ("") oder wie null festlegen, wird der Kennwortschutz aus dem WorksheetProtection Objekt entfernt. Der Arbeitsblattschutz muss aktiviert und angehalten sein, damit diese Methode ordnungsgemäß funktioniert. Wenn der Arbeitsblattschutz deaktiviert ist, gibt diese Methode einen InvalidOperation Fehler aus und ändert das Kennwort nicht. Wenn der Arbeitsblattschutz aktiviert und nicht angehalten ist, gibt diese Methode einen AccessDenied Fehler aus und ändert das Kennwort nicht.
setPassword(password?: string): void;Parameter
- password
-
string
Das dem Objekt zugeordnete WorksheetProtection Kennwort.
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 sie übergeben wird.) Während das ursprüngliche Excel.WorksheetProtection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.WorksheetProtectionData) zurück, das 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
Kennwort für Arbeitsblattschutz.
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 WorksheetProtection Objekt zugeordneten Arbeitsblattschutzoptionen. 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 die Arbeitsblattschutzoptionen nicht ändern.
updateOptions(options: Excel.WorksheetProtectionOptions): void;Parameter
- options
- Excel.WorksheetProtectionOptions
Die dem Objekt zugeordnete WorksheetProtection Optionsschnittstelle.
Gibt zurück
void