Excel.Workbook class

このブックを含む Excel アプリケーション インスタンスを表します。

readonly application: Excel.Application;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

ブックの一部であるバインドのコレクションを表します。

readonly bindings: Excel.BindingCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

context: RequestContext;

プロパティ値

計算に使用できるワークシート関数のコレクションを表します。

readonly functions: Excel.Functions;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

ブックスコープの名前付き項目 (名前付き範囲と定数) のコレクションを表します。

readonly names: Excel.NamedItemCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

ブックに関連付けられているピボットテーブルのコレクションを表します。

readonly pivotTables: Excel.PivotTableCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the workbook.
  const pivotTables = context.workbook.pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the workbook:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

ブックに関連付けられているテーブルのコレクションを表します。

readonly tables: Excel.TableCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

ブックに関連付けられているワークシートのコレクションを表します。

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

ブックから現在選択されている 1 つの範囲を取得します。 複数の範囲が選択されている場合、このメソッドはエラーをスローします。

getSelectedRange(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

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

load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

戻り値

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Workbook): void;

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.WorkbookData;

戻り値

ドキュメント内で選択が変更されるときに発生します。

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

イベントの種類

注釈

[ API セット: ExcelApi 1.2 ]