ExcelScript.AllowEditRange interface
ワークシート内にある AllowEditRange オブジェクトを表します。 このオブジェクトは、ワークシート保護プロパティで動作します。 ワークシート保護を有効にすると、 AllowEditRange オブジェクトを使用して、ワークシートの残りの部分で保護を維持しながら、特定の範囲の編集を許可できます。
メソッド
| delete() |
|
| get |
オブジェクトに関連付けられている範囲を指定します。 |
| get |
オブジェクトがパスワードで保護されているかどうかを指定します。 |
| get |
オブジェクトのタイトルを指定します。 |
| pause |
現在のセッションのユーザーのオブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 ワークシート保護を一時停止できない場合、このメソッドは |
| set |
オブジェクトに関連付けられている範囲を指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは |
| set |
オブジェクトに関連付けられているパスワードを変更します。 パスワード文字列を空 ("") または |
| set |
オブジェクトのタイトルを指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは |
メソッドの詳細
delete()
AllowEditRangeCollection
からオブジェクトを削除します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、削除操作に失敗します。
delete(): void;
戻り値
void
getAddress()
オブジェクトに関連付けられている範囲を指定します。
getAddress(): string;
戻り値
string
getIsPasswordProtected()
オブジェクトがパスワードで保護されているかどうかを指定します。
getIsPasswordProtected(): boolean;
戻り値
boolean
getTitle()
オブジェクトのタイトルを指定します。
getTitle(): string;
戻り値
string
pauseProtection(password)
現在のセッションのユーザーのオブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 ワークシート保護を一時停止できない場合、このメソッドは UnsupportedOperation エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが正しくない場合、このメソッドは BadPassword エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが指定されていてもオブジェクトにパスワードが必要ない場合、入力されたパスワードは無視され、操作は成功します。
pauseProtection(password?: string): void;
パラメーター
- password
-
string
AllowEditRange オブジェクトに関連付けられているパスワード。
戻り値
void
setAddress(address)
オブジェクトに関連付けられている範囲を指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、範囲の設定に失敗します。
setAddress(address: string): void;
パラメーター
- address
-
string
戻り値
void
setPassword(password)
オブジェクトに関連付けられているパスワードを変更します。 パスワード文字列を空 ("") または null に設定すると、オブジェクトからパスワード保護が削除されます。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシートの保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、設定操作は失敗します。
setPassword(password?: string): void;
パラメーター
- password
-
string
AllowEditRange オブジェクトに関連付けられているパスワード。
戻り値
void
setTitle(title)
オブジェクトのタイトルを指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、タイトルの設定に失敗します。 同じ文字列を持つ既存の AllowEditRange が既にある場合、または文字列が null または空 ("") の場合、このメソッドは InvalidArgument エラーをスローし、タイトルの設定に失敗します。
setTitle(title: string): void;
パラメーター
- title
-
string
戻り値
void