Excel.Binding class

ブックで定義されている Office.js のバインディングを表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

id

バインド識別子を表します。

type

バインドの型を返します。 詳細は「Excel.BindingType」をご覧ください。

メソッド

delete()

バインドを削除します。

getRange()

バインディングによって表される範囲を返します。 バインドが正しい型でない場合は、エラーがスローされます。

getTable()

バインドによって表されるテーブルを返します。 バインドが正しい型でない場合は、エラーがスローされます。

getText()

バインドによって表されるテキストを返します。 バインドが正しい型でない場合は、エラーがスローされます。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

イベント

onDataChanged

バインド内でデータまたは書式設定が変更されるときに発生します。

onSelectionChanged

バインドで選択したコンテンツが変更されたときに発生します。

*: 複数の不明確なセルが選択されている場合、 Binding.onSelectionChanged 1 つの選択に関する行と列の情報のみがレポートされます。 複数の選択した範囲に使用 Worksheet.onSelectionChanged します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

id

バインド識別子を表します。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

type

バインドの型を返します。 詳細は「Excel.BindingType」をご覧ください。

readonly type: Excel.BindingType | "Range" | "Table" | "Text";

プロパティ値

Excel.BindingType | "Range" | "Table" | "Text"

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

delete()

バインドを削除します。

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.3 ]

getRange()

バインディングによって表される範囲を返します。 バインドが正しい型でない場合は、エラーがスローされます。

getRange(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

await Excel.run(async (context) => { 
    const binding = context.workbook.bindings.getItemAt(0);
    const range = binding.getRange();
    range.load('cellCount');
    await context.sync();

    console.log(range.cellCount);
});

getTable()

バインドによって表されるテーブルを返します。 バインドが正しい型でない場合は、エラーがスローされます。

getTable(): Excel.Table;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

await Excel.run(async (context) => { 
    const binding = context.workbook.bindings.getItemAt(0);
    const table = binding.getTable();
    table.load('name');
    await context.sync();

    console.log(table.name);
});

getText()

バインドによって表されるテキストを返します。 バインドが正しい型でない場合は、エラーがスローされます。

getText(): OfficeExtension.ClientResult<string>;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

await Excel.run(async (context) => { 
    const binding = context.workbook.bindings.getItemAt(0);
    const text = binding.getText();
    binding.load('text');
    await context.sync();

    console.log(text);
});

load(options)

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

load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;

パラメーター

options
Excel.Interfaces.BindingLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

await Excel.run(async (context) => { 
    const binding = context.workbook.bindings.getItemAt(0);
    binding.load('type');
    await context.sync();

    console.log(binding.type);
});

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

toJSON()

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

toJSON(): Excel.Interfaces.BindingData;

戻り値

イベントの詳細

onDataChanged

バインド内でデータまたは書式設定が変更されるときに発生します。

readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;

イベントの種類

注釈

[ API セット: ExcelApi 1.2 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");    
    const salesTable = sheet.tables.getItem("SalesTable");
    const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
    salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);

    console.log("The data changed handler is registered.");

    await context.sync();
});

onSelectionChanged

バインドで選択したコンテンツが変更されたときに発生します。

*: 複数の不明確なセルが選択されている場合、 Binding.onSelectionChanged 1 つの選択に関する行と列の情報のみがレポートされます。 複数の選択した範囲に使用 Worksheet.onSelectionChanged します。

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;

イベントの種類

注釈

[ API セット: ExcelApi 1.2 ]