ExcelScript.WorksheetProtection interface

パッケージ:

ExcelScript

ワークシート オブジェクトの保護を表します。

注釈

例

/**
 * This script pauses the protection of a worksheet by using the provided password.
 * This password could come from a Power Automate flow.
 */
function main(workbook: ExcelScript.Workbook, password: string) {
  // Get the worksheet named "Sales".
  const sheet = workbook.getWorksheet("Sales");
  const protection: ExcelScript.WorksheetProtection = sheet.getProtection();
  
  // Check if the provided password works.
  if (protection.checkPassword(password)) {
    protection.pauseProtection(password);

    // Edit the worksheet...

    protection.resumeProtection();
  } else {
    console.log("Incorrect password");
  }
}

メソッド

addAllowEditRange(title, rangeAddress, options)	ワークシートに AllowEditRange オブジェクトを追加します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、追加操作は失敗します。
checkPassword(password)	パスワードを使用してワークシート保護のロックを解除できるかどうかを指定します。 このメソッドでは、ワークシート保護の状態は変更されません。 パスワードを入力しても、ワークシート保護のロックを解除するためにパスワードが必要ない場合、このメソッドは false を返します。
getAllowEditRange(key)	オブジェクトを AllowEditRange タイトルで取得します。
getAllowEditRanges()	このワークシート内の AllowEditRangeCollection オブジェクトを指定します。 これは、ワークシート保護プロパティを使用するオブジェクトの AllowEditRange コレクションです。 ワークシート保護を有効にすると、オブジェクトを AllowEditRange 使用して特定の範囲の編集を許可しながら、ワークシートの残りの部分で保護を維持できます。
getCanPauseProtection()	このワークシートの保護を一時停止できるかどうかを指定します。
getIsPasswordProtected()	シートがパスワードで保護されているかどうかを指定します。
getIsPaused()	ワークシートの保護を一時停止するかどうかを指定します。
getOptions()	ワークシートの保護オプションを指定します。
getProtected()	ワークシートが保護されているかどうかを指定します。
getSavedOptions()	ワークシートに保存されている保護オプションを指定します。 これにより、ワークシートの保護状態に関係なく、同じ WorksheetProtectionOptions オブジェクトが返されます。
pauseProtection(password)	現在のセッションのユーザーの特定のワークシート オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 パスワードが正しくない場合、このメソッドはエラーを InvalidArgument スローし、保護の一時停止に失敗します。 ワークシートの保護が有効になっていないか、既に一時停止している場合、このメソッドは保護の状態を変更しません。
pauseProtectionForAllAllowEditRanges(password)	現在のセッションのユーザーに対して指定されたパスワードを持つ、このワークシート内のすべての AllowEditRange オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていない場合、または一時停止されている場合、このメソッドは何も実行しません。 ワークシートの保護を一時停止できない場合、このメソッドはエラーを UnsupportedOperation スローし、範囲の保護を一時停止できません。 パスワードがコレクション内の AllowEditRange オブジェクトと一致しない場合、このメソッドはエラーを BadPassword スローし、コレクション内の任意の範囲の保護を一時停止できません。
protect(options, password)	ワークシートを保護します。 ワークシートが既に保護されている場合、失敗します。
resumeProtection()	特定のセッション内のユーザーの特定のワークシート オブジェクトのワークシート保護を再開します。 このメソッドを機能させるには、ワークシートの保護を一時停止する必要があります。 ワークシートの保護が一時停止されていない場合、このメソッドはワークシートの保護状態を変更しません。
setPassword(password)	オブジェクトに関連付けられているパスワードを WorksheetProtection 変更します。 パスワードを空の文字列 ("") または as として null 設定すると、オブジェクトからパスワード保護が WorksheetProtection 削除されます。 このメソッドを正常に動作させるには、ワークシート保護を有効にして一時停止する必要があります。 ワークシート保護が無効になっている場合、このメソッドはエラーを InvalidOperation スローし、パスワードの変更に失敗します。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、パスワードの変更に失敗します。
unprotect(password)	ワークシートの保護を解除します。
updateOptions(options)	オブジェクトに関連付けられているワークシート保護オプションを WorksheetProtection 変更します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、ワークシート保護オプションの変更に失敗します。

メソッドの詳細

addAllowEditRange(title, rangeAddress, options)

ワークシートに AllowEditRange オブジェクトを追加します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、追加操作は失敗します。

addAllowEditRange(
            title: string,
            rangeAddress: string,
            options?: AllowEditRangeOptions
        ): void;

パラメーター

title

string

追加するオブジェクトの AllowEditRange タイトル文字列。

rangeAddress

string

追加するオブジェクトの AllowEditRange 範囲アドレス。

options

ExcelScript.AllowEditRangeOptions

パスワードなど、オブジェクトに追加する AllowEditRange 追加のオプション。

戻り値

void

checkPassword(password)

パスワードを使用してワークシート保護のロックを解除できるかどうかを指定します。 このメソッドでは、ワークシート保護の状態は変更されません。 パスワードを入力しても、ワークシート保護のロックを解除するためにパスワードが必要ない場合、このメソッドは false を返します。

checkPassword(password?: string): boolean;

パラメーター

password

string

保護されたワークシートに対してチェックするパスワード。

戻り値

boolean

getAllowEditRange(key)

オブジェクトを AllowEditRange タイトルで取得します。

getAllowEditRange(key: string): AllowEditRange | undefined;

パラメーター

key

string

の AllowEditRangeタイトル。

戻り値

ExcelScript.AllowEditRange | undefined

getAllowEditRanges()

このワークシート内の AllowEditRangeCollection オブジェクトを指定します。 これは、ワークシート保護プロパティを使用するオブジェクトの AllowEditRange コレクションです。 ワークシート保護を有効にすると、オブジェクトを AllowEditRange 使用して特定の範囲の編集を許可しながら、ワークシートの残りの部分で保護を維持できます。

getAllowEditRanges(): AllowEditRange[];

戻り値

ExcelScript.AllowEditRange[]

getCanPauseProtection()

このワークシートの保護を一時停止できるかどうかを指定します。

getCanPauseProtection(): boolean;

戻り値

boolean

getIsPasswordProtected()

シートがパスワードで保護されているかどうかを指定します。

getIsPasswordProtected(): boolean;

戻り値

boolean

getIsPaused()

ワークシートの保護を一時停止するかどうかを指定します。

getIsPaused(): boolean;

戻り値

boolean

getOptions()

ワークシートの保護オプションを指定します。

getOptions(): WorksheetProtectionOptions;

戻り値

ExcelScript.WorksheetProtectionOptions

getProtected()

ワークシートが保護されているかどうかを指定します。

getProtected(): boolean;

戻り値

boolean

getSavedOptions()

ワークシートに保存されている保護オプションを指定します。 これにより、ワークシートの保護状態に関係なく、同じ WorksheetProtectionOptions オブジェクトが返されます。

getSavedOptions(): WorksheetProtectionOptions;

戻り値

ExcelScript.WorksheetProtectionOptions

pauseProtection(password)

現在のセッションのユーザーの特定のワークシート オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 パスワードが正しくない場合、このメソッドはエラーを InvalidArgument スローし、保護の一時停止に失敗します。 ワークシートの保護が有効になっていないか、既に一時停止している場合、このメソッドは保護の状態を変更しません。

pauseProtection(password?: string): void;

パラメーター

password

string

保護されたワークシートに関連付けられているパスワード。

戻り値

void

pauseProtectionForAllAllowEditRanges(password)

現在のセッションのユーザーに対して指定されたパスワードを持つ、このワークシート内のすべての AllowEditRange オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていない場合、または一時停止されている場合、このメソッドは何も実行しません。 ワークシートの保護を一時停止できない場合、このメソッドはエラーを UnsupportedOperation スローし、範囲の保護を一時停止できません。 パスワードがコレクション内の AllowEditRange オブジェクトと一致しない場合、このメソッドはエラーを BadPassword スローし、コレクション内の任意の範囲の保護を一時停止できません。

pauseProtectionForAllAllowEditRanges(password: string): void;

パラメーター

password

string

オブジェクトの保護を一時停止するための AllowEditRange パスワード。

戻り値

void

protect(options, password)

ワークシートを保護します。 ワークシートが既に保護されている場合、失敗します。

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

パラメーター

options

ExcelScript.WorksheetProtectionOptions

省略可能です。 シートの保護のオプション。

password

string

省略可能です。 シート保護パスワード。

戻り値

void

例

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

resumeProtection()

特定のセッション内のユーザーの特定のワークシート オブジェクトのワークシート保護を再開します。 このメソッドを機能させるには、ワークシートの保護を一時停止する必要があります。 ワークシートの保護が一時停止されていない場合、このメソッドはワークシートの保護状態を変更しません。

resumeProtection(): void;

戻り値

void

setPassword(password)

オブジェクトに関連付けられているパスワードを WorksheetProtection 変更します。 パスワードを空の文字列 ("") または as として null 設定すると、オブジェクトからパスワード保護が WorksheetProtection 削除されます。 このメソッドを正常に動作させるには、ワークシート保護を有効にして一時停止する必要があります。 ワークシート保護が無効になっている場合、このメソッドはエラーを InvalidOperation スローし、パスワードの変更に失敗します。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、パスワードの変更に失敗します。

setPassword(password?: string): void;

パラメーター

password

string

オブジェクトに WorksheetProtection 関連付けられているパスワード。

戻り値

void

unprotect(password)

ワークシートの保護を解除します。

unprotect(password?: string): void;

パラメーター

password

string

シート保護パスワード。

戻り値

void

updateOptions(options)

オブジェクトに関連付けられているワークシート保護オプションを WorksheetProtection 変更します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドはエラーを AccessDenied スローし、ワークシート保護オプションの変更に失敗します。

updateOptions(options: WorksheetProtectionOptions): void;

パラメーター

options

ExcelScript.WorksheetProtectionOptions

オブジェクトに関連付 WorksheetProtection けられているオプション インターフェイス。

戻り値

void