Office.TableBinding interface

TableBinding 内の列の数を整数値として取得します。

columnCount: number;

プロパティ値

例

function showBindingColumnCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Column: " + asyncResult.value.columnCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

True を指定します。テーブルにヘッダーがある場合は 。それ以外の場合は false。

hasHeaders: boolean;

プロパティ値

例

function showBindingHasHeaders() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Binding has headers: " + asyncResult.value.hasHeaders);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

TableBinding 内の行数を整数値として取得します。

rowCount: number;

プロパティ値

注釈

Excel on desktop と Excel on the web で 1 行を選択して空のテーブルを挿入する場合 ([挿入] タブの [テーブル] を使用)、両方の Office アプリケーションで 1 行のヘッダーが作成され、その後に 1 つの空白行が作成されます。 ただし、アドインのスクリプトでこの新しく挿入されたテーブルのバインド (たとえば、Office.Bindings.addFromSelectionAsync メソッドを使用して) を作成し、rowCount プロパティの値を確認する場合、返される値は Excel on desktop または Excel on the web で開かれているかどうかによって異なります。

• デスクトップ上の Excel (Windows と Mac) では、rowCount は 0 を返します (ヘッダーの後の空白行はカウントされません)。

• Excel on the web では、rowCount は 1 を返します (ヘッダーの後の空白行がカウントされます)。

スクリプトでこの違いを回避するには、rowCount == 1 かどうかを確認し、これが真の場合、行に含まれている文字列がすべて空であるかどうかを確認します。

例

function showBindingRowCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Rows: " + asyncResult.value.rowCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

指定したデータを追加の列としてテーブルに追加します。

addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

データとヘッダーの値を指定する 1 つ以上の列を追加するには、Data パラメーターとして TableData オブジェクトを渡します。 データのみを指定する 1 つ以上の列を追加するには、配列の配列 ("matrix") を data パラメーターとして渡します。

addColumnsAsync 操作の成功または失敗はアトミックです。 つまり、列を追加する操作はその全体が成功する必要があり、1 つでもエラーが発生すると、操作全体がロールバックされます (コールバックに返される AsyncResult.status プロパティもエラーを報告します)。

• データ引数として渡す配列内の各行には、更新するテーブルと同じ数の行が必要です。 そうでないと、操作全体が失敗します。

• 配列内の各行とセルは、新しく追加された列のテーブルにその行またはセルを正常に追加する必要があります。 何らかの理由によって、行またはセルを設定できなかった場合は、操作全体が失敗します。

• TableData オブジェクトをデータ引数として渡す場合、ヘッダー行の数は、更新するテーブルの行数と一致する必要があります。

Web 上の Excel の追加の説明: このメソッドの 1 回の呼び出しで、データ パラメーターに渡される TableData オブジェクト内のセルの合計数は 20,000 を超えることはできません。

例

// The following example adds a single column with three rows to a bound table with the id "myTable"
// by passing a TableData object as the data argument of the addColumnsAsync method. To succeed,
// the table being updated must have three rows.

// Add a column to a binding of type table by passing a TableData object.
function addColumns() {
    const myTable = new Office.TableData();
    myTable.headers = [["Cities"]];
    myTable.rows = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

// The following example adds a single column with three rows to a bound table with the id myTable
// by passing an array of arrays ("matrix") as the data argument of the addColumnsAsync method.
// To succeed, the table being updated must have three rows.

// Add a column to a binding of type table by passing an array of arrays.
function addColumns() {
    const myTable = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

指定したデータを追加の列としてテーブルに追加します。

addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

データとヘッダーの値を指定する 1 つ以上の列を追加するには、Data パラメーターとして TableData オブジェクトを渡します。 データのみを指定する 1 つ以上の列を追加するには、配列の配列 ("matrix") を data パラメーターとして渡します。

addColumnsAsync 操作の成功または失敗はアトミックです。 つまり、列を追加する操作はその全体が成功する必要があり、1 つでもエラーが発生すると、操作全体がロールバックされます (コールバックに返される AsyncResult.status プロパティもエラーを報告します)。

• データ引数として渡す配列内の各行には、更新するテーブルと同じ数の行が必要です。 そうでないと、操作全体が失敗します。

• 配列内の各行とセルは、新しく追加された列のテーブルにその行またはセルを正常に追加する必要があります。 何らかの理由によって、行またはセルを設定できなかった場合は、操作全体が失敗します。

• TableData オブジェクトをデータ引数として渡す場合、ヘッダー行の数は、更新するテーブルの行数と一致する必要があります。

Web 上の Excel の追加の説明: このメソッドの 1 回の呼び出しで、データ パラメーターに渡される TableData オブジェクト内のセルの合計数は 20,000 を超えることはできません。

指定したデータをテーブルに追加の行として追加します。

addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

addRowsAsync 操作の成功または失敗はアトミックです。 つまり、列を追加する操作はその全体が成功する必要があり、1 つでもエラーが発生すると、操作全体がロールバックされます (コールバックに返される AsyncResult.status プロパティもエラーを報告します)。

• データ引数として渡す配列の各行には、更新するテーブルと同じ数の列が必要です。 そうでないと、操作全体が失敗します。

• 配列内の各列とセルは、新しく追加された行のテーブルにその列またはセルを正常に追加する必要があります。 何らかの理由で列またはセルの設定に失敗した場合、操作全体が失敗します。

• TableData オブジェクトをデータ引数として渡す場合、ヘッダー行の数は、更新するテーブルの行数と一致する必要があります。

Web 上の Excel の追加の説明: このメソッドの 1 回の呼び出しで、データ パラメーターに渡される TableData オブジェクト内のセルの合計数は 20,000 を超えることはできません。

例

function addRowsToTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.addRowsAsync([["6", "k"], ["7", "j"]]);
    });
}

指定したデータをテーブルに追加の行として追加します。

addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

addRowsAsync 操作の成功または失敗はアトミックです。 つまり、列を追加する操作はその全体が成功する必要があり、1 つでもエラーが発生すると、操作全体がロールバックされます (コールバックに返される AsyncResult.status プロパティもエラーを報告します)。

• データ引数として渡す配列の各行には、更新するテーブルと同じ数の列が必要です。 そうでないと、操作全体が失敗します。

• 配列内の各列とセルは、新しく追加された行のテーブルにその列またはセルを正常に追加する必要があります。 何らかの理由で列またはセルの設定に失敗した場合、操作全体が失敗します。

• TableData オブジェクトをデータ引数として渡す場合、ヘッダー行の数は、更新するテーブルの行数と一致する必要があります。

Web 上の Excel の追加の説明: このメソッドの 1 回の呼び出しで、データ パラメーターに渡される TableData オブジェクト内のセルの合計数は 20,000 を超えることはできません。

バインド テーブルの書式設定をクリアします。

clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

詳細については、「 Excel 用アドインのテーブルの書式設定 」を参照してください。

例

// The following example shows how to clear the formatting of the bound table with an ID of "myBinding":
Office.select("bindings#myBinding").clearFormatsAsync();

バインド テーブルの書式設定をクリアします。

clearFormatsAsync(callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

詳細については、「 Excel 用アドインのテーブルの書式設定 」を参照してください。

Office アプリケーション用に適切にシフトして、テーブル内のすべてのヘッダー以外の行とその値を削除します。

deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

Excel では、テーブルにヘッダー行が含まれていない場合、このメソッドはテーブルそのものを削除します。

例

function deleteAllRowsFromTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.deleteAllDataValuesAsync();
    });
}

Office アプリケーション用に適切にシフトして、テーブル内のすべてのヘッダー以外の行とその値を削除します。

deleteAllDataValuesAsync(callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

Excel では、テーブルにヘッダー行が含まれていない場合、このメソッドはテーブルそのものを削除します。

テーブル内の指定した項目の書式設定を取得します。

getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

パラメーター

戻り値

注釈

返される形式の構造体

戻り値配列内の各 JavaScript オブジェクトには、次の形式があります。 {cells:{ cell_range }, format:{ format_definition }}

cells: プロパティは、次のいずれかの値を使用して書式を設定する範囲を指定します。

cells プロパティでサポートされている範囲

format: プロパティは、Excel の [セルの書式設定] ダイアログ ボックスで使用できる設定のサブセットに対応する値を指定します (コンテキスト メニューを開く (右クリックまたは選択して長押し) し、[セルの書式設定] または [ホーム>Format>セルの書式設定)] を選択します。

テーブル内の指定した項目の書式設定を取得します。

getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

パラメーター

戻り値

注釈

返される形式の構造体

戻り値配列内の各 JavaScript オブジェクトには、次の形式があります。 {cells:{ cell_range }, format:{ format_definition }}

cells: プロパティは、次のいずれかの値を使用して書式を設定する範囲を指定します。

cells プロパティでサポートされている範囲

format: プロパティは、Excel の [セルの書式設定] ダイアログ ボックスで使用できる設定のサブセットに対応する値を指定します (コンテキスト メニューを開く (右クリックまたは選択して長押し) し、[セルの書式設定] または [ホーム>Format>セルの書式設定)] を選択します。

指定した項目とテーブル内のデータの書式を設定します。

setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

cellFormat パラメーターを指定する

cellFormat パラメーターを使用して、幅、高さ、フォント、背景、配置などのセルの書式設定値を設定または変更します。 cellFormat パラメーターとして渡す値は、ターゲットにするセル (cells:) と適用する形式 (format:) を指定する 1 つ以上の JavaScript オブジェクトのリストを含む配列です。

cellFormat 配列内の各 JavaScript オブジェクトには、次の形式があります。 {cells:{ cell_range }, format:{ format_definition }}

cells: プロパティは、次のいずれかの値を使用して書式を設定する範囲を指定します。

cells プロパティでサポートされている範囲

format: プロパティは、Excel の [セルの書式設定] ダイアログ ボックスで使用できる設定のサブセットに対応する値を指定します (コンテキスト メニューを開く (右クリックまたは選択して長押し) し、[セルの書式設定] または [ホーム>Format>セルの書式設定)] を選択します。

format: プロパティの値は、JavaScript オブジェクト リテラル内の 1 つ以上のプロパティ名と値のペアの一覧として指定します。 The property name specifies the name of the formatting property to set, and value specifies the property value. You can specify multiple values for a given format, such as both a font's color and size.

Here's three format: property value examples:

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

numberFormat: プロパティで数値書式 "code" 文字列を指定することで、数値形式を指定できます。 この文字列に指定できる数値の形式は、Excel の [ セルの書式設定] ダイアログ ボックスの [ 表示形式] タブの [ ユーザー定義] 分類項目で設定できる形式に対応しています。 次の例は、数値を小数点以下 2 桁を含むパーセントとして表示する方法を示しています。

format: {numberFormat:"0.00%"}

詳細については、「カスタム数値形式を作成する方法」を参照してください。

データの書き込み時にテーブルの書式設定を設定するには、 Document.setSelectedDataAsync または TableBinding.setDataAsync メソッドの tableOptions および cellFormat 省略可能なパラメーターを使用します。

Document.setSelectedDataAsync メソッドと TableBinding.setDataAsync メソッドの省略可能なパラメーターを使用した書式設定の設定は、初めてデータを書き込むときに書式設定を設定する場合にのみ機能します。 データの書き込み後に書式設定を変更するには、次のメソッドを使用します。

• フォントの色やスタイルなどのセルの書式設定を更新するには、 TableBinding.setFormatsAsync メソッド (このメソッド) を使用します。

• グループ化された行やフィルター ボタンなどのテーブル オプションを更新するには、 TableBinding.setTableOptions メソッドを使用します。

• 書式設定をクリアするには、 TableBinding.clearFormats メソッドを使用します。

詳細と例については、「 Excel 用アドインでテーブルを書式設定する方法」を参照してください。

例

// Specifying a single target
// The following example shows a cellFormat value that sets the font color of the header row to red.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: Office.Table.Headers, format: {fontColor: "red"}}], 
    function (asyncResult){});

// Specifying multiple targets
// The setFormatsAsync method can support formatting multiple targets within the bound table in a 
// single function call. To do that, you pass a list of objects in the cellFormat array 
// for each target that you want to format.
// For example, the following line of code will set the font color of the first row yellow, 
// and the fourth cell in the third row to have a white border and bold text.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

// Additional remarks for Excel Online
// The number of formatting groups passed to the cellFormat parameter can't exceed 100. 
// A single formatting group consists of a set of formatting applied to a specified range of cells. 
// For example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

指定した項目とテーブル内のデータの書式を設定します。

setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

cellFormat パラメーターを指定する

cellFormat パラメーターを使用して、幅、高さ、フォント、背景、配置などのセルの書式設定値を設定または変更します。 cellFormat パラメーターとして渡す値は、ターゲットにするセル (cells:) と適用する形式 (format:) を指定する 1 つ以上の JavaScript オブジェクトのリストを含む配列です。

cellFormat 配列内の各 JavaScript オブジェクトには、次の形式があります。 {cells:{ cell_range }, format:{ format_definition }}

cells: プロパティは、次のいずれかの値を使用して書式を設定する範囲を指定します。

cells プロパティでサポートされている範囲

format: プロパティは、Excel の [セルの書式設定] ダイアログ ボックスで使用できる設定のサブセットに対応する値を指定します (コンテキスト メニューを開く (右クリックまたは選択して長押し) し、[セルの書式設定] または [ホーム>Format>セルの書式設定)] を選択します。

format: プロパティの値は、JavaScript オブジェクト リテラル内の 1 つ以上のプロパティ名と値のペアの一覧として指定します。 The property name specifies the name of the formatting property to set, and value specifies the property value. You can specify multiple values for a given format, such as both a font's color and size.

Here's three format: property value examples:

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

numberFormat: プロパティで数値書式 "code" 文字列を指定することで、数値形式を指定できます。 この文字列に指定できる数値の形式は、Excel の [ セルの書式設定] ダイアログ ボックスの [ 表示形式] タブの [ ユーザー定義] 分類項目で設定できる形式に対応しています。 次の例は、数値を小数点以下 2 桁を含むパーセントとして表示する方法を示しています。

format: {numberFormat:"0.00%"}

詳細については、「カスタム数値形式を作成する方法」を参照してください。

データの書き込み時にテーブルの書式設定を設定するには、 Document.setSelectedDataAsync または TableBinding.setDataAsync メソッドの tableOptions および cellFormat 省略可能なパラメーターを使用します。

Document.setSelectedDataAsync メソッドと TableBinding.setDataAsync メソッドの省略可能なパラメーターを使用した書式設定の設定は、初めてデータを書き込むときに書式設定を設定する場合にのみ機能します。 データの書き込み後に書式設定を変更するには、次のメソッドを使用します。

• フォントの色やスタイルなどのセルの書式設定を更新するには、 TableBinding.setFormatsAsync メソッド (このメソッド) を使用します。

• グループ化された行やフィルター ボタンなどのテーブル オプションを更新するには、 TableBinding.setTableOptions メソッドを使用します。

• 書式設定をクリアするには、 TableBinding.clearFormats メソッドを使用します。

詳細と例については、「 Excel 用アドインでテーブルを書式設定する方法」を参照してください。

バインド テーブルにおけるテーブル書式設定オプションを更新します。

setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

要件セット: セットに含まれていない

goToByIdAsync メソッドに渡されるコールバック関数で、AsyncResult オブジェクトのプロパティを使用して、次の情報を返すことができます。

例

// The following example shows how to:
// 1. Create an object literal that specifies the table formatting options to update on the bound table.
// 2. Call setTableOptions on a previously bound table (with an id of myBinding) passing the object
//    with formatting setting as the tableOptions parameter.
function updateTableFormatting(){
    const tableOptions = {bandedRows: true, filterButton: false, style: "TableStyleMedium3"}; 

    Office.select("bindings#myBinding").setTableOptionsAsync(tableOptions, function(asyncResult){});
}

バインド テーブルにおけるテーブル書式設定オプションを更新します。

setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;

パラメーター

戻り値

注釈

要件セット: セットに含まれていない

goToByIdAsync メソッドに渡されるコールバック関数で、AsyncResult オブジェクトのプロパティを使用して、次の情報を返すことができます。