Excel.TableColumnCollection class

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

context: RequestContext;

プロパティ値

テーブルの列数を返します。

readonly count: number;

プロパティ値

注釈

API セット: ExcelApi 1.1

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

readonly items: Excel.TableColumn[];

プロパティ値

テーブルに新しい列を追加します。

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;

パラメーター

返品

注釈

API セット: ExcelApi 1.1 では、列の合計数より小さいインデックスが必要です。1.4 では、インデックスを省略可能 (null または -1) することができ、末尾に列が追加されます。1.4 では、作成時に name パラメーターを使用できます。

例

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

テーブルに新しい列を追加します。 add() とは異なり、addAsJson() は、画像やエンティティのデータ型など、任意の種類のセル値を受け取ります。

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

パラメーター

返品

注釈

API セット: ExcelApi 1.16

表の列数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: ExcelApi 1.4

名前または ID によって、列オブジェクトを取得します。

getItem(key: number | string): Excel.TableColumn;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Remove all content from the Analysis column.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Clear all the data from the second column.
  range.clearOrResetContents();
  await context.sync();
});

コレクション内の位置に基づいて列を取得します。

getItemAt(index: number): Excel.TableColumn;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

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

getItemOrNullObject(key: number | string): Excel.TableColumn;

パラメーター

返品

注釈

API セット: ExcelApi 1.4

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

load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection;

パラメーター

返品

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

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

パラメーター

返品

例

await Excel.run(async (context) => { 
    const tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.TableColumnCollectionData;

返品