Excel.AllowEditRange class

パッケージ:

excel

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

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApiOnline 1.1 ]

プロパティ

address	オブジェクトに関連付けられている範囲を指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、範囲の設定に失敗します。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
isPasswordProtected	オブジェクトがパスワードで保護されているかどうかを指定します。
title	オブジェクトのタイトルを指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、タイトルの設定に失敗します。 同じ文字列を持つ既存の AllowEditRange が既にある場合、または文字列が null または空 ("") の場合、このメソッドは InvalidArgument エラーをスローし、タイトルの設定に失敗します。

メソッド

delete()	AllowEditRangeCollection からオブジェクトを削除します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、削除操作に失敗します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
pauseProtection(password)	現在のセッションのユーザーのオブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 ワークシート保護を一時停止できない場合、このメソッドは UnsupportedOperation エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが正しくない場合、このメソッドは BadPassword エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが指定されていてもオブジェクトにパスワードが必要ない場合、入力されたパスワードは無視され、操作は成功します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setPassword(password)	オブジェクトに関連付けられているパスワードを変更します。 パスワード文字列を空 ("") または null に設定すると、オブジェクトからパスワード保護が削除されます。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシートの保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、設定操作は失敗します。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.AllowEditRange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.AllowEditRangeData として型指定) を返します。

プロパティの詳細

address

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

address: string;

プロパティ値

string

注釈

[ API セット: ExcelApiOnline 1.1 ]

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

isPasswordProtected

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

readonly isPasswordProtected: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApiOnline 1.1 ]

title

オブジェクトのタイトルを指定します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、タイトルの設定に失敗します。 同じ文字列を持つ既存の AllowEditRange が既にある場合、または文字列が null または空 ("") の場合、このメソッドは InvalidArgument エラーをスローし、タイトルの設定に失敗します。

title: string;

プロパティ値

string

注釈

[ API セット: ExcelApiOnline 1.1 ]

メソッドの詳細

delete()

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

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;

パラメーター

options

Excel.Interfaces.AllowEditRangeLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.AllowEditRange

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.AllowEditRange;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.AllowEditRange

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.AllowEditRange;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.AllowEditRange

pauseProtection(password)

現在のセッションのユーザーのオブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていないか、既に一時停止されている場合、このメソッドは何も実行しません。 ワークシート保護を一時停止できない場合、このメソッドは UnsupportedOperation エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが正しくない場合、このメソッドは BadPassword エラーをスローし、オブジェクトの保護を一時停止できません。 パスワードが指定されていてもオブジェクトにパスワードが必要ない場合、入力されたパスワードは無視され、操作は成功します。

pauseProtection(password?: string): void;

パラメーター

password

string

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

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties

Excel.Interfaces.AllowEditRangeUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.AllowEditRange): void;

パラメーター

properties

Excel.AllowEditRange

戻り値

void

setPassword(password)

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

setPassword(password?: string): void;

パラメーター

password

string

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

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.AllowEditRange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.AllowEditRangeData として型指定) を返します。

toJSON(): Excel.Interfaces.AllowEditRangeData;

戻り値

Excel.Interfaces.AllowEditRangeData