Excel.Binding class

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

context: RequestContext;

プロパティ値

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

readonly id: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

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

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

プロパティ値

注釈

API セット: ExcelApi 1.1

バインドを削除します。

delete(): void;

返品

注釈

API セット: ExcelApi 1.3

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

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

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

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

パラメーター

返品

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

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

パラメーター

返品

例

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

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

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.BindingData;

返品

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

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

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

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

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

イベントの種類

注釈

API セット: ExcelApi 1.2