Office.TableBinding interface

バインドを行と列の 2 次元で、必要に応じてヘッダーと共に表します。

注釈

TableBinding オブジェクトは、 id プロパティ、 type プロパティ、 getDataAsync メソッド、および setDataAsync メソッドを Office.Binding オブジェクトから継承します。

Excel の場合、テーブルバインドを確立した後、ユーザーがテーブルに追加する新しい行ごとに自動的にバインドに含まれ、rowCount が増加することに注意してください。

プロパティ

columnCount	TableBinding の列数を整数値として取得します。
hasHeaders	テーブルにヘッダーがある場合は true。それ以外の場合は false。
rowCount	TableBinding の行数を整数値として取得します。

メソッド

addColumnsAsync(tableData, options, callback)	指定したデータを列としてテーブルに追加します。
addColumnsAsync(tableData, callback)	指定したデータを列としてテーブルに追加します。
addRowsAsync(rows, options, callback)	指定したデータを行としてテーブルに追加します。
addRowsAsync(rows, callback)	指定したデータを行としてテーブルに追加します。
clearFormatsAsync(options, callback)	バインドテーブルの書式設定をクリアします。
clearFormatsAsync(callback)	バインドテーブルの書式設定をクリアします。
deleteAllDataValuesAsync(options, callback)	テーブル内のすべてのヘッダー以外の行とその値を削除し、Office アプリケーションに合わせてシフトします。
deleteAllDataValuesAsync(callback)	テーブル内のすべてのヘッダー以外の行とその値を削除し、Office アプリケーションに合わせてシフトします。
getFormatsAsync(cellReference, formats, options, callback)	テーブル内の指定されたアイテムの書式設定を取得します。
getFormatsAsync(cellReference, formats, callback)	テーブル内の指定されたアイテムの書式設定を取得します。
setFormatsAsync(cellFormat, options, callback)	テーブル内の指定された項目とデータの書式設定を設定します。
setFormatsAsync(cellFormat, callback)	テーブル内の指定された項目とデータの書式設定を設定します。
setTableOptionsAsync(tableOptions, options, callback)	バインドテーブルにおけるテーブル書式設定オプションを更新します。
setTableOptionsAsync(tableOptions, callback)	バインドテーブルにおけるテーブル書式設定オプションを更新します。

columnCount

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

columnCount: number;

プロパティ値

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

hasHeaders

テーブルにヘッダーがある場合は true。それ以外の場合は false。

hasHeaders: boolean;

プロパティ値

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

rowCount

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

rowCount: number;

プロパティ値

number

注釈

デスクトップ上の Excel と Excel on the web ([挿入] タブの [表] を使用) で 1 行を選択して空の表を挿入すると、両方の Office アプリケーションで 1 行のヘッダーと 1 つの空白行が作成されます。ただし、アドインのスクリプトで (たとえば、Office.Bindings.addFromSelectionAsync メソッドを使用して) 新しく挿入されたテーブルのバインドを作成し、rowCount プロパティの値を確認する場合、スプレッドシートがデスクトップ版 Excel と 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, options, callback)

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

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

パラメーター

tableData: Office.TableData | any[][]

テーブルに追加する 1 つ以上の列のデータを含む配列 ("行列") または TableData オブジェクト。必須です。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

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

データ引数として渡す配列内の各行は、更新するテーブルと同じ数の行である必要があります。そうでないと、操作全体が失敗します。
配列内の各行とセルは、新しく追加される列のテーブルにその行またはセルを正常に追加する必要があります。何らかの理由によって、行またはセルを設定できなかった場合は、操作全体が失敗します。
TableData オブジェクトをデータ引数として渡す場合、ヘッダー行数は更新するテーブルの行数と一致する必要があります。

Excel on the web に関するその他の注意事項: このメソッドの 1 回の呼び出しで、data パラメーターに渡される 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, callback)

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

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

パラメーター

tableData: Office.TableData | any[][]

テーブルに追加する 1 つ以上の列のデータを含む配列 ("行列") または TableData オブジェクト。必須です。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

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

データ引数として渡す配列内の各行は、更新するテーブルと同じ数の行である必要があります。そうでないと、操作全体が失敗します。
配列内の各行とセルは、新しく追加される列のテーブルにその行またはセルを正常に追加する必要があります。何らかの理由によって、行またはセルを設定できなかった場合は、操作全体が失敗します。
TableData オブジェクトをデータ引数として渡す場合、ヘッダー行数は更新するテーブルの行数と一致する必要があります。

Excel on the web に関するその他の注意事項: このメソッドの 1 回の呼び出しで、data パラメーターに渡される TableData オブジェクト内のセルの合計数が 20,000 を超えることはできません。

addRowsAsync(rows, options, callback)

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

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

パラメーター

rows: Office.TableData | any[][]

テーブルに追加する 1 つ以上の行データを含む配列の配列 ("行列") または TableData オブジェクト。必須です。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

データ引数として渡す配列の各行は、更新されるテーブルと同じ数の列である必要があります。そうでないと、操作全体が失敗します。
配列内の各列とセルは、新しく追加される行のテーブルにその列またはセルを正常に追加する必要があります。何らかの理由でいずれかの列またはセルの設定に失敗した場合、操作全体が失敗します。
TableData オブジェクトをデータ引数として渡す場合、ヘッダー行数は更新するテーブルの行数と一致する必要があります。

Excel on the web に関するその他の注意事項: このメソッドの 1 回の呼び出しで、data パラメーターに渡される 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, callback)

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

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

パラメーター

rows: Office.TableData | any[][]

テーブルに追加する 1 つ以上の行データを含む配列の配列 ("行列") または TableData オブジェクト。必須です。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

データ引数として渡す配列の各行は、更新されるテーブルと同じ数の列である必要があります。そうでないと、操作全体が失敗します。
配列内の各列とセルは、新しく追加される行のテーブルにその列またはセルを正常に追加する必要があります。何らかの理由でいずれかの列またはセルの設定に失敗した場合、操作全体が失敗します。
TableData オブジェクトをデータ引数として渡す場合、ヘッダー行数は更新するテーブルの行数と一致する必要があります。

Excel on the web に関するその他の注意事項: このメソッドの 1 回の呼び出しで、data パラメーターに渡される TableData オブジェクト内のセルの合計数が 20,000 を超えることはできません。

clearFormatsAsync(options, callback)

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

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

パラメーター

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

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)

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

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

パラメーター

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

deleteAllDataValuesAsync(options, callback)

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

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

パラメーター

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

例

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

deleteAllDataValuesAsync(callback)

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

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

パラメーター

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

getFormatsAsync(cellReference, formats, options, callback)

テーブル内の指定されたアイテムの書式設定を取得します。

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

パラメーター

cellReference: any

書式設定を取得するセルの範囲を指定する名前と値のペアを含むオブジェクトリテラル。

formats: any[]

取得するフォーマットプロパティを指定する配列。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。結果の value プロパティは、対応するセルの書式設定を指定する 1 つ以上の JavaScript オブジェクトを含む配列です。

返品

void

注釈

返される形式構造体

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

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

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

`cells` 範囲の設定	説明
`{row: n}`	テーブルの 0 から始まるデータの n 行目の範囲を指定します。
`{column: n}`	テーブル内のデータの 0 から始まる n 番目の列の範囲を指定します。
`{row: i, column: j}`	テーブルの i 行目と j 列目となる単一のセルを指定します。
`Office.Table.All`	列見出し、データ、集計 (もしあれば) を含むテーブル全体を指定します。
`Office.Table.Data`	テーブル内のデータのみ (見出しと集計を含まない) を指定します。
`Office.Table.Headers`	見出し行のみを指定します。

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

getFormatsAsync(cellReference, formats, callback)

テーブル内の指定されたアイテムの書式設定を取得します。

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

パラメーター

cellReference: any

書式設定を取得するセルの範囲を指定する名前と値のペアを含むオブジェクトリテラル。

formats: any[]

取得するフォーマットプロパティを指定する配列。

callback: (result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。結果の value プロパティは、対応するセルの書式設定を指定する 1 つ以上の JavaScript オブジェクトを含む配列です。

返品

void

注釈

返される形式構造体

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

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

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

`cells` 範囲の設定	説明
`{row: n}`	テーブルの 0 から始まるデータの n 行目の範囲を指定します。
`{column: n}`	テーブル内のデータの 0 から始まる n 番目の列の範囲を指定します。
`{row: i, column: j}`	テーブルの i 行目と j 列目となる単一のセルを指定します。
`Office.Table.All`	列見出し、データ、集計 (もしあれば) を含むテーブル全体を指定します。
`Office.Table.Data`	テーブル内のデータのみ (見出しと集計を含まない) を指定します。
`Office.Table.Headers`	見出し行のみを指定します。

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

setFormatsAsync(cellFormat, options, callback)

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

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

パラメーター

cellFormat: any[]

ターゲットとなるセルと、対象セルに適用する書式設定を指定した 1 つ以上の JavaScript オブジェクトが含まれる配列。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

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

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

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

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

`cells` 範囲の設定	説明
`{row: n}`	テーブルの 0 から始まるデータの n 行目の範囲を指定します。
`{column: n}`	テーブル内のデータの 0 から始まる n 番目の列の範囲を指定します。
`{row: i, column: j}`	テーブルの i 行目と j 列目となる単一のセルを指定します。
`Office.Table.All`	列見出し、データ、集計 (もしあれば) を含むテーブル全体を指定します。
`Office.Table.Data`	テーブル内のデータのみ (見出しと集計を含まない) を指定します。
`Office.Table.Headers`	見出し行のみを指定します。

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

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, callback)

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

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

パラメーター

cellFormat: any[]

ターゲットとなるセルと、対象セルに適用する書式設定を指定した 1 つ以上の JavaScript オブジェクトが含まれる配列。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

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

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

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

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

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

`cells` 範囲の設定	説明
`{row: n}`	テーブルの 0 から始まるデータの n 行目の範囲を指定します。
`{column: n}`	テーブル内のデータの 0 から始まる n 番目の列の範囲を指定します。
`{row: i, column: j}`	テーブルの i 行目と j 列目となる単一のセルを指定します。
`Office.Table.All`	列見出し、データ、集計 (もしあれば) を含むテーブル全体を指定します。
`Office.Table.Data`	テーブル内のデータのみ (見出しと集計を含まない) を指定します。
`Office.Table.Headers`	見出し行のみを指定します。

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

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, options, callback)

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

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

パラメーター

tableOptions: any

オブジェクトリテラルは、適用するテーブルオプションを定義するプロパティ名と値のペアのリストです。

options: Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

要件セット: セットにない

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

プロパティ	使用
`AsyncResult.value`	書式設定時に取得するデータまたはオブジェクトがないため、常に `undefined` を返します。
`AsyncResult.status`	操作の成功または失敗を判断します。
`AsyncResult.error`	操作が失敗した場合、エラーに関する情報を提供する Error オブジェクトにアクセスします。
`AsyncResult.asyncContext`	変更せずに 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, callback)

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

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

パラメーター

tableOptions: any

オブジェクトリテラルは、適用するテーブルオプションを定義するプロパティ名と値のペアのリストです。

callback: (result: Office.AsyncResult<void>) => void

省略可能。コールバックが返されたときに呼び出される関数。その唯一のパラメーターは Office.AsyncResult 型です。

返品

void

注釈

要件セット: セットにない

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

プロパティ	使用
`AsyncResult.value`	書式設定時に取得するデータまたはオブジェクトがないため、常に `undefined` を返します。
`AsyncResult.status`	操作の成功または失敗を判断します。
`AsyncResult.error`	操作が失敗した場合、エラーに関する情報を提供する Error オブジェクトにアクセスします。
`AsyncResult.asyncContext`	変更せずに AsyncResult オブジェクトで返される任意の型の項目を定義します。

注釈

プロパティ

メソッド

プロパティの詳細

columnCount

プロパティ値

例

hasHeaders

プロパティ値

例

rowCount

プロパティ値

注釈

例

メソッドの詳細

addColumnsAsync(tableData, options, callback)

パラメーター

返品

注釈

例

addColumnsAsync(tableData, callback)

パラメーター

返品

注釈

addRowsAsync(rows, options, callback)

パラメーター

返品

注釈

例

addRowsAsync(rows, callback)

パラメーター

返品

注釈

clearFormatsAsync(options, callback)

パラメーター

返品

注釈

例

clearFormatsAsync(callback)

パラメーター

返品

注釈

deleteAllDataValuesAsync(options, callback)

パラメーター

返品

注釈

例

deleteAllDataValuesAsync(callback)

パラメーター

返品

注釈

getFormatsAsync(cellReference, formats, options, callback)

パラメーター

返品

注釈

getFormatsAsync(cellReference, formats, callback)

パラメーター

返品

注釈

setFormatsAsync(cellFormat, options, callback)

パラメーター

返品

注釈

例

setFormatsAsync(cellFormat, callback)

パラメーター

返品

注釈

setTableOptionsAsync(tableOptions, options, callback)

パラメーター

返品

注釈

例

setTableOptionsAsync(tableOptions, callback)

パラメーター

返品

注釈

フィードバック