Excel.Workbook class

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

readonly application: Excel.Application;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

ブックが自動保存モードかどうかを指定します。

readonly autoSave: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

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

readonly bindings: Excel.BindingCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

Excel 計算エンジンのバージョンとして数字を返します。

readonly calculationEngineVersion: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。 False の場合、グラフは、データ ポイントのインデックスを追跡します。

chartDataPointTrack: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

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

readonly comments: Excel.CommentCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

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

context: RequestContext;

プロパティ値

このブックに含まれるカスタム XML パーツのコレクションを表します。

readonly customXmlParts: Excel.CustomXmlPartCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.5 ]

ブック内のすべてのデータ接続を表します。

readonly dataConnections: Excel.DataConnectionCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

readonly functions: Excel.Functions;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

ブックが最後に保存されてから変更が加えられたかどうかを指定します。 このプロパティは、変更したブックを保存せずに閉じるか、保存するように求められる場合は、 true に設定できます。

isDirty: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

ブックの名前を取得します。

readonly name: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

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

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

ブックがローカルまたはオンラインで保存されたかどうかを指定します。

readonly previouslySaved: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

ブックのプロパティを取得します。

readonly properties: Excel.DocumentProperties;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml

await Excel.run(async (context) => {
    let titleValue = "Excel document properties API";
    let subjectValue = "Set and get document properties";
    let keywordsValue = "Set and get operations";
    let commentsValue = "This is an Excel document properties API code sample";
    let categoryValue = "Office Add-ins";
    let managerValue = "John";
    let companyValue = "Microsoft";

    let docProperties = context.workbook.properties;

    // Set the writeable document properties.
    docProperties.title = titleValue;
    docProperties.subject = subjectValue;
    docProperties.keywords = keywordsValue;
    docProperties.comments = commentsValue;
    docProperties.category = categoryValue;
    docProperties.manager = managerValue;
    docProperties.company = companyValue;

    await context.sync();

    console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});

ブックの保護オブジェクトを返します。

readonly protection: Excel.WorkbookProtection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

ブックの一部であるPower Queryクエリのコレクションを返します。

readonly queries: Excel.QueryCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

ブックが読み取り専用モードで開いている場合は、 true を返します。

readonly readOnly: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

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

readonly settings: Excel.SettingCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.4 ]

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

readonly slicers: Excel.SlicerCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

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

readonly slicerStyles: Excel.SlicerStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

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

readonly styles: Excel.StyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

例

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

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

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

readonly tables: Excel.TableCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

readonly tableStyles: Excel.TableStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

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

readonly timelineStyles: Excel.TimelineStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

ブックを表示桁数でのみ計算する場合、true となります。 このプロパティを false から true に切り替えると、データの精度が完全に失われます。

usePrecisionAsDisplayed: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

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

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

現在のブックを閉じます。

close(closeBehavior?: Excel.CloseBehavior): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.11 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.close(Excel.CloseBehavior.save);
});

現在のブックを閉じます。

close(closeBehaviorString?: "Save" | "SkipSave"): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.11 ]

ブックで現在アクティブなセルを取得します。

getActiveCell(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let activeCell = myWorkbook.getActiveCell();
    activeCell.load("address");

    await context.sync();
    
    console.log("The active cell is " + activeCell.address);
});

ブックで現在アクティブになっているグラフを取得します。 アクティブなグラフがない場合は、 ItemNotFound 例外がスローされます。

getActiveChart(): Excel.Chart;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

ブックで現在アクティブになっているグラフを取得します。 アクティブなグラフがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getActiveChartOrNullObject(): Excel.Chart;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

ブックで現在アクティブになっているスライサーを取得します。 アクティブなスライサーがない場合は、 ItemNotFound 例外がスローされます。

getActiveSlicer(): Excel.Slicer;

戻り値

注釈

[ API セット: ExcelApi 1.10 ]

ブックで現在アクティブになっているスライサーを取得します。 アクティブなスライサーがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getActiveSlicerOrNullObject(): Excel.Slicer;

戻り値

注釈

[ API セット: ExcelApi 1.10 ]

ブックが複数のユーザーによって (共同編集によって) 編集されている場合は、 true を返します。 ブックの状態が変わると、メソッドの結果に変更が反映されるまでに遅延が発生する可能性があることに注意してください。

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

指定されたLinkedEntityIdに基づいてLinkedEntityCellValueを返します。

getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.16 ]

ブックから現在選択されている 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);
});

ブックから現在選択されている 1 つまたは複数の範囲を取得します。 getSelectedRange() とは異なり、このメソッドは、選択したすべての範囲を表すRangeAreas オブジェクトを返します。

getSelectedRanges(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

例

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

await Excel.run(async (context) => {

    const selectedRanges = context.workbook.getSelectedRanges();
    selectedRanges.format.fill.color = "lightblue";

    await context.sync();
})

ソース ブックから現在のブックに指定したワークシートを挿入します。

注*: この API は現在、Windows、Mac、および Web 上の Office でのみサポートされています。

insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;

パラメーター

戻り値

新しく挿入された各ワークシートに対応する ID の配列。

注釈

[ API セット: ExcelApi 1.13 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml

// Retrieve the file and set up an HTML FileReader element. 
const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
    // Remove the metadata before the Base64-encoded string.
    const startIndex = reader.result.toString().indexOf("base64,");
    externalWorkbook = reader.result.toString().substr(startIndex + 7);
};

// Read the file as a data URL so that we can parse the Base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

...

await Excel.run(async (context) => {
    // Retrieve the source workbook.
    const workbook = context.workbook;
    
    // Set up the insert options.
    const options = {
        sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
        positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
        relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
    };
    
    // Insert the new worksheets.
    workbook.insertWorksheetsFromBase64(externalWorkbook, options);
    await context.sync();
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、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;

パラメーター

戻り値

現在のブックを保存します。

save(saveBehavior?: Excel.SaveBehavior): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.11 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.save(Excel.SaveBehavior.save);
});

現在のブックを保存します。

save(saveBehaviorString?: "Save" | "Prompt"): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.11 ]

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の 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 onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;

イベントの種類

注釈

[ API セット: ExcelApi 1.13 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml

async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) {
  await Excel.run(async (context) => {
    // Callback function for when the workbook is activated.
    console.log("The workbook was activated.");
  });
}

...

await Excel.run(async (context) => {
  const workbook = context.workbook;

  // Register the workbook activated event handler.
  workbook.onActivated.add(workbookActivated);

  await context.sync();
  console.log("Added event handler for workbook activated.");
});

ブックの [自動保存] 設定が変更されたときに発生します。

readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;

イベントの種類

注釈

[ API セット: ExcelApi 1.9 ]

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

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

イベントの種類

注釈

[ API セット: ExcelApi 1.2 ]