Excel.BindingCollection class

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

context: RequestContext;

プロパティ値

コレクション内にあるバインドの数を取得します。

readonly count: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

readonly items: Excel.Binding[];

プロパティ値

特定の範囲に新しいバインドを追加します。

add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

特定の範囲に新しいバインドを追加します。

add(range: Range | string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。

addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。

addFromNamedItem(name: string, bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。

addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。

addFromSelection(bindingTypeString: "Range" | "Table" | "Text", id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

コレクションに含まれるバインドの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

ID を使用してバインド オブジェクトを取得します。

getItem(id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

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: number): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

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);
});

ID を使用してバインド オブジェクトを取得します。 バインド オブジェクトが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(id: string): Excel.Binding;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

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

load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

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);
    }
});

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

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

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.BindingCollectionData;

戻り値