Excel.WorksheetProtection class
ワークシート オブジェクトの保護を表します。
- Extends
注釈
プロパティ
| allow |
このワークシートで見つかった |
| can |
このワークシートの保護を一時停止できるかどうかを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| is |
シートがパスワードで保護されているかどうかを指定します。 |
| is |
ワークシートの保護を一時停止するかどうかを指定します。 |
| options | ワークシートの保護オプションを指定します。 |
| protected | ワークシートが保護されているかどうかを指定します。 |
| saved |
ワークシートに保存されている保護オプションを指定します。 これにより、ワークシートの保護状態に関係なく、同じ |
メソッド
| check |
パスワードを使用してワークシート保護のロックを解除できるかどうかを指定します。 このメソッドでは、ワークシート保護の状態は変更されません。 パスワードを入力しても、ワークシート保護のロックを解除するためにパスワードが必要ない場合、このメソッドは false を返します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| pause |
現在のセッションのユーザーの特定のワークシート オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 パスワードが正しくない場合、このメソッドは |
| protect(options, password) | ワークシートを保護します。 ワークシートが既に保護されている場合、失敗します。 |
| resume |
特定のセッション内のユーザーの特定のワークシート オブジェクトのワークシート保護を再開します。 このメソッドを機能させるには、ワークシートの保護を一時停止する必要があります。 ワークシートの保護が一時停止されていない場合、このメソッドはワークシートの保護状態を変更しません。 |
| set |
|
| toJSON() | API オブジェクトが |
| unprotect(password) | ワークシートの保護を解除します。 |
| update |
|
プロパティの詳細
allowEditRanges
このワークシートで見つかった AllowEditRangeCollection オブジェクトを指定します。 これは、ワークシート保護プロパティを使用する AllowEditRange オブジェクトのコレクションです。 ワークシート保護を有効にすると、 AllowEditRange オブジェクトを使用して、ワークシートの残りの部分で保護を維持しながら、特定の範囲の編集を許可できます。
readonly allowEditRanges: Excel.AllowEditRangeCollection;プロパティ値
注釈
canPauseProtection
このワークシートの保護を一時停止できるかどうかを指定します。
readonly canPauseProtection: boolean;プロパティ値
boolean
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
isPasswordProtected
シートがパスワードで保護されているかどうかを指定します。
readonly isPasswordProtected: boolean;プロパティ値
boolean
注釈
isPaused
ワークシートの保護を一時停止するかどうかを指定します。
readonly isPaused: boolean;プロパティ値
boolean
注釈
options
ワークシートの保護オプションを指定します。
readonly options: Excel.WorksheetProtectionOptions;プロパティ値
注釈
protected
savedOptions
ワークシートに保存されている保護オプションを指定します。 これにより、ワークシートの保護状態に関係なく、同じ WorksheetProtectionOptions オブジェクトが返されます。
readonly savedOptions: Excel.WorksheetProtectionOptions;プロパティ値
注釈
メソッドの詳細
checkPassword(password)
パスワードを使用してワークシート保護のロックを解除できるかどうかを指定します。 このメソッドでは、ワークシート保護の状態は変更されません。 パスワードを入力しても、ワークシート保護のロックを解除するためにパスワードが必要ない場合、このメソッドは false を返します。
checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;パラメーター
- password
-
string
保護されたワークシートに対して確認するパスワード。
戻り値
OfficeExtension.ClientResult<boolean>
パスワードを使用してワークシート保護のロックを解除できる場合は、 true を返します。 それ以外の場合は、 falseを返します。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.WorksheetProtection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.WorksheetProtection;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
pauseProtection(password)
現在のセッションのユーザーの特定のワークシート オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 パスワードが正しくない場合、このメソッドは InvalidArgument エラーをスローし、保護の一時停止に失敗します。 ワークシートの保護が有効になっていないか、既に一時停止している場合、このメソッドは保護の状態を変更しません。
pauseProtection(password?: string): void;パラメーター
- password
-
string
保護されたワークシートに関連付けられているパスワード。
戻り値
void
注釈
protect(options, password)
ワークシートを保護します。 ワークシートが既に保護されている場合、失敗します。
protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;パラメーター
- options
- Excel.WorksheetProtectionOptions
省略可能。 シートの保護のオプション。
- password
-
string
省略可能。 シート保護パスワード。
戻り値
void
注釈
[ API セット: オプションの場合は ExcelApi 1.2、パスワードの場合は 1.7 ]
例
// 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()
特定のセッション内のユーザーの特定のワークシート オブジェクトのワークシート保護を再開します。 このメソッドを機能させるには、ワークシートの保護を一時停止する必要があります。 ワークシートの保護が一時停止されていない場合、このメソッドはワークシートの保護状態を変更しません。
resumeProtection(): void;戻り値
void
注釈
setPassword(password)
WorksheetProtection オブジェクトに関連付けられているパスワードを変更します。 パスワードを空の文字列 ("") または null として設定すると、 WorksheetProtection オブジェクトからパスワード保護が削除されます。 このメソッドを正常に動作させるには、ワークシート保護を有効にして一時停止する必要があります。 ワークシート保護が無効になっている場合、このメソッドは InvalidOperation エラーをスローし、パスワードの変更に失敗します。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、パスワードの変更に失敗します。
setPassword(password?: string): void;パラメーター
- password
-
string
WorksheetProtection オブジェクトに関連付けられているパスワード。
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.WorksheetProtection オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.WorksheetProtectionData として型指定) を返します。
toJSON(): Excel.Interfaces.WorksheetProtectionData;戻り値
unprotect(password)
ワークシートの保護を解除します。
unprotect(password?: string): void;パラメーター
- password
-
string
シート保護パスワード。
戻り値
void
注釈
[ API セット: ExcelApi 1.7 for password ]
例
// 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)
WorksheetProtection オブジェクトに関連付けられているワークシート保護オプションを変更します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、ワークシート保護オプションの変更に失敗します。
updateOptions(options: Excel.WorksheetProtectionOptions): void;パラメーター
- options
- Excel.WorksheetProtectionOptions
WorksheetProtection オブジェクトに関連付けられているオプション インターフェイス。
戻り値
void
注釈
Office Add-ins