Excel.BindingCollection class
ブックの一部であるすべてのバインド オブジェクトのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | コレクション内にあるバインドの数を取得します。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(range, binding |
特定の範囲に新しいバインドを追加します。 |
| add(range, binding |
特定の範囲に新しいバインドを追加します。 |
| add |
ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 |
| add |
ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 |
| add |
現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 |
| add |
現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 |
| get |
ID を使用してバインド オブジェクトを取得します。 |
| get |
項目の配列内の位置に基づいて、バインド オブジェクトを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
items
メソッドの詳細
add(range, bindingType, id)
特定の範囲に新しいバインドを追加します。
add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;パラメーター
- range
-
Excel.Range | string
バインドをバインドする範囲です。
Range オブジェクトまたは文字列を指定できます。 文字列の場合は、シート名を含む完全なアドレスが含まれている必要があります
- bindingType
- Excel.BindingType
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
add(range, bindingTypeString, id)
特定の範囲に新しいバインドを追加します。
add(range: Range | string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;パラメーター
- range
-
Excel.Range | string
バインドをバインドする範囲です。
Range オブジェクトまたは文字列を指定できます。 文字列の場合は、シート名を含む完全なアドレスが含まれている必要があります
- bindingTypeString
-
"Range" | "Table" | "Text"
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
addFromNamedItem(name, bindingType, id)
ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。
addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;パラメーター
- name
-
string
バインドの作成元の名前です。
- bindingType
- Excel.BindingType
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
addFromNamedItem(name, bindingTypeString, id)
ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。
addFromNamedItem(name: string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;パラメーター
- name
-
string
バインドの作成元の名前です。
- bindingTypeString
-
"Range" | "Table" | "Text"
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
addFromSelection(bindingType, id)
現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。
addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;パラメーター
- bindingType
- Excel.BindingType
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
addFromSelection(bindingTypeString, id)
現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。
addFromSelection(bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;パラメーター
- bindingTypeString
-
"Range" | "Table" | "Text"
バインドの種類。
Excel.BindingType
を参照してください。
- id
-
string
バインドの名前。
戻り値
注釈
getItem(id)
ID を使用してバインド オブジェクトを取得します。
getItem(id: string): Excel.Binding;パラメーター
- id
-
string
取得するバインド オブジェクトの ID。
戻り値
注釈
例
async function onBindingDataChanged(eventArgs) {
await Excel.run(async (context) => {
// Highlight the table related to the binding in orange to indicate data has been changed.
context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange";
await context.sync();
console.log("The value in this table got changed!");
});
}
getItemAt(index)
項目の配列内の位置に基づいて、バインド オブジェクトを取得します。
getItemAt(index: number): Excel.Binding;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
例
await Excel.run(async (context) => {
const lastPosition = context.workbook.bindings.count - 1;
const binding = context.workbook.bindings.getItemAt(lastPosition);
binding.load('type')
await context.sync();
console.log(binding.type);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.BindingCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await Excel.run(async (context) => {
const bindings = context.workbook.bindings;
bindings.load('items');
await context.sync();
for (let i = 0; i < bindings.items.length; i++) {
console.log(bindings.items[i].id);
}
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.BindingCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.BindingCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.BindingCollectionData;戻り値
Office Add-ins