Excel.AllowEditRangeCollection class
ワークシート内にあるオブジェクトの AllowEditRange セットを表します。 AllowEditRange オブジェクトはワークシート保護プロパティで動作します。 ワークシート保護を有効にすると、オブジェクトを AllowEditRange 使用して特定の範囲の編集を許可しながら、ワークシートの残りの部分で保護を維持できます。
- Extends
注釈
[ API セット: ExcelApiOnline 1.1 ]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(title, range |
ワークシートに |
| get |
コレクション内のオブジェクトの |
| get |
オブジェクトを |
| get |
コレクション内の |
| get |
オブジェクトを |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| pause |
現在のセッションのユーザーに対して指定されたパスワードを持つ、このワークシート内のすべての |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
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
注釈
getCount()
コレクション内のオブジェクトの AllowEditRange 数を返します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(key)
オブジェクトを AllowEditRange タイトルで取得します。
getItem(key: string): Excel.AllowEditRange;パラメーター
- key
-
string
の AllowEditRangeタイトル。
戻り値
AllowEditRangeタイトルを含む 。 指定されたタイトルが存在しない AllowEditRange 場合は、 ItemNotFound エラーがスローされます。
注釈
getItemAt(index)
コレクション内の AllowEditRange インデックスによってオブジェクトを返します。
getItemAt(index: number): Excel.AllowEditRange;パラメーター
- index
-
number
コレクション内の AllowEditRange オブジェクトのインデックス。
戻り値
AllowEditRange指定したインデックス位置の 。
注釈
getItemOrNullObject(key)
オブジェクトを AllowEditRange タイトルで取得します。
getItemOrNullObject(key: string): Excel.AllowEditRange;パラメーター
- key
-
string
の AllowEditRangeタイトル。
戻り値
AllowEditRangeタイトルを含む 。 指定されたタイトルが存在しないAllowEditRange場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;パラメーター
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.AllowEditRangeCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
pauseProtection(password)
現在のセッションのユーザーに対して指定されたパスワードを持つ、このワークシート内のすべての AllowEditRange オブジェクトのワークシート保護を一時停止します。 ワークシートの保護が有効になっていない場合、または一時停止されている場合、このメソッドは何も実行しません。 ワークシートの保護を一時停止できない場合、このメソッドはエラーを UnsupportedOperation スローし、範囲の保護を一時停止できません。 パスワードがコレクション内の AllowEditRange オブジェクトと一致しない場合、このメソッドはエラーを BadPassword スローし、コレクション内の任意の範囲の保護を一時停止できません。
pauseProtection(password: string): void;パラメーター
- password
-
string
オブジェクトの保護を一時停止するための AllowEditRange パスワード。
戻り値
void
注釈
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元 Excel.AllowEditRangeCollection のオブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.AllowEditRangeCollectionData型指定) を返します。
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示