Excel.AllowEditRangeCollection class

パッケージ:

excel

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

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApiOnline 1.1 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(title, rangeAddress, options)	ワークシートに AllowEditRange オブジェクトを追加します。 このメソッドを正常に動作させるには、ワークシート保護を無効または一時停止する必要があります。 ワークシート保護が有効になっていて一時停止していない場合、このメソッドは AccessDenied エラーをスローし、追加操作は失敗します。
getCount()	コレクション内の AllowEditRange オブジェクトの数を返します。
getItem(key)	AllowEditRange オブジェクトをタイトルで取得します。
getItemAt(index)	コレクション内のインデックスによって AllowEditRange オブジェクトを返します。
getItemOrNullObject(key)	AllowEditRange オブジェクトをタイトルで取得します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
pauseProtection(password)	現在のセッションのユーザーに対して指定されたパスワードを持つ、このワークシート内にあるすべての AllowEditRange オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていない場合、または一時停止されている場合、このメソッドは何も実行しません。 ワークシートの保護を一時停止できない場合、このメソッドは UnsupportedOperation エラーをスローし、範囲の保護を一時停止できません。 パスワードがコレクション内の AllowEditRange オブジェクトと一致しない場合、このメソッドは BadPassword エラーをスローし、コレクション内の任意の範囲の保護を一時停止できません。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.AllowEditRangeCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.AllowEditRangeCollectionDataとして型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.AllowEditRange[];

プロパティ値

Excel.AllowEditRange[]

メソッドの詳細

add(title, rangeAddress, options)

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

add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;

パラメーター

title

string

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

rangeAddress

string

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

options

Excel.AllowEditRangeOptions

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

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

getCount()

コレクション内の AllowEditRange オブジェクトの数を返します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItem(key)

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

getItem(key: string): Excel.AllowEditRange;

パラメーター

key

string

AllowEditRange のタイトル。

戻り値

Excel.AllowEditRange

タイトルを含む AllowEditRange 。 指定したタイトルに AllowEditRange がない場合は、 ItemNotFound エラーがスローされます。

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItemAt(index)

コレクション内のインデックスによって AllowEditRange オブジェクトを返します。

getItemAt(index: number): Excel.AllowEditRange;

パラメーター

index

number

コレクション内の AllowEditRange オブジェクトのインデックス。

戻り値

Excel.AllowEditRange

指定されたインデックスの AllowEditRange 。

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

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

getItemOrNullObject(key: string): Excel.AllowEditRange;

パラメーター

key

string

AllowEditRange のタイトル。

戻り値

Excel.AllowEditRange

タイトルを含む AllowEditRange 。 指定したタイトルに AllowEditRange がない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

注釈

[ API セット: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;

パラメーター

options

Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

Excel.AllowEditRangeCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.AllowEditRangeCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;

パラメーター

propertyNamesAndPaths

OfficeExtension.LoadOption

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

戻り値

Excel.AllowEditRangeCollection

pauseProtection(password)

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

pauseProtection(password: string): void;

パラメーター

password

string

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

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

toJSON()

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

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

戻り値

Excel.Interfaces.AllowEditRangeCollectionData