Excel. Workbook class

autoSave

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

readonly autoSave: boolean;

プロパティ値

boolean

注釈

bindings

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

readonly bindings: Excel.BindingCollection;

プロパティ値

Excel.BindingCollection

注釈

calculationEngineVersion

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

readonly calculationEngineVersion: number;

プロパティ値

number

注釈

chartDataPointTrack

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

chartDataPointTrack: boolean;

プロパティ値

boolean

注釈

comments

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

readonly comments: Excel.CommentCollection;

プロパティ値

Excel.CommentCollection

注釈

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

customXmlParts

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

readonly customXmlParts: Excel.CustomXmlPartCollection;

プロパティ値

Excel.CustomXmlPartCollection

注釈

[ API セット: ExcelApi 1.5 ]

dataConnections

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

readonly dataConnections: Excel.DataConnectionCollection;

プロパティ値

Excel.DataConnectionCollection

注釈

functions

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

readonly functions: Excel.Functions;

プロパティ値

Excel.Functions

注釈

[ API セット: ExcelApi 1.2 ]

isDirty

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

isDirty: boolean;

プロパティ値

boolean

注釈

name

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

readonly name: string;

プロパティ値

string

注釈

names

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

readonly names: Excel.NamedItemCollection;

プロパティ値

Excel.NamedItemCollection

注釈

pivotTables

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

readonly pivotTables: Excel.PivotTableCollection;

プロパティ値

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

pivotTableStyles

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

プロパティ値

Excel.PivotTableStyleCollection

注釈

previouslySaved

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

readonly previouslySaved: boolean;

プロパティ値

boolean

注釈

properties

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

readonly properties: Excel.DocumentProperties;

プロパティ値

Excel.DocumentProperties

注釈

例

// 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.");
});

protection

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

readonly protection: Excel.WorkbookProtection;

プロパティ値

Excel.WorkbookProtection

注釈

readOnly

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

readonly readOnly: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

settings

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

readonly settings: Excel.SettingCollection;

プロパティ値

Excel.SettingCollection

注釈

[ API セット: ExcelApi 1.4 ]

slicers

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

readonly slicers: Excel.SlicerCollection;

プロパティ値

Excel.SlicerCollection

注釈

slicerStyles

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

readonly slicerStyles: Excel.SlicerStyleCollection;

プロパティ値

Excel.SlicerStyleCollection

注釈

styles

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

readonly styles: Excel.StyleCollection;

プロパティ値

Excel.StyleCollection

注釈

例

// 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.");
});

tables

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

readonly tables: Excel.TableCollection;

プロパティ値

Excel.TableCollection

注釈

tableStyles

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

readonly tableStyles: Excel.TableStyleCollection;

プロパティ値

Excel.TableStyleCollection

注釈

timelineStyles

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

readonly timelineStyles: Excel.TimelineStyleCollection;

プロパティ値

Excel.TimelineStyleCollection

注釈

usePrecisionAsDisplayed

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

usePrecisionAsDisplayed: boolean;

プロパティ値

boolean

注釈

worksheets

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

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

Excel.WorksheetCollection

注釈

メソッドの詳細

close(closeBehavior)

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

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

パラメーター

closeBehavior: Excel.CloseBehavior

ブックの閉じる動作。

戻り値

void

注釈

例

// 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)

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

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

パラメーター

closeBehaviorString: "Save" | "SkipSave"

ブックの閉じる動作。

戻り値

void

注釈

getActiveCell()

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

getActiveCell(): Excel.Range;

戻り値

Excel.Range

注釈

例

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

getActiveChart()

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

getActiveChart(): Excel.Chart;

戻り値

Excel.Chart

注釈

getActiveChartOrNullObject()

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

getActiveChartOrNullObject(): Excel.Chart;

戻り値

Excel.Chart

注釈

getActiveSlicer()

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

getActiveSlicer(): Excel.Slicer;

戻り値

Excel.Slicer

注釈

getActiveSlicerOrNullObject()

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

getActiveSlicerOrNullObject(): Excel.Slicer;

戻り値

Excel.Slicer

注釈

getIsActiveCollabSession()

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

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

戻り値

OfficeExtension.ClientResult<boolean>

注釈

getSelectedRange()

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

getSelectedRange(): Excel.Range;

戻り値

Excel.Range

注釈

例

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

getSelectedRanges()

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

getSelectedRanges(): Excel.RangeAreas;

戻り値

Excel.RangeAreas

注釈

例

// 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();
})

load(options)

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

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

パラメーター

options: Excel.Interfaces.WorkbookLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.Workbook

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.Workbook

load(propertyNamesAndPaths)

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

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.Workbook

save(saveBehavior)

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

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

パラメーター

saveBehavior: Excel.SaveBehavior

保存動作は、"保存" または "プロンプト" である必要があります。既定値は "Save" です。

戻り値

void

注釈

例

// 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(saveBehaviorString?: "Save" | "Prompt"): void;

パラメーター

saveBehaviorString: "Save" | "Prompt"

保存動作は、"保存" または "プロンプト" である必要があります。既定値は "Save" です。

戻り値

void

注釈

OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>

set(properties, options)

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

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

パラメーター

properties: Excel.Interfaces.WorkbookUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Excel.Workbook): void;

パラメーター

properties: Excel.Workbook

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.WorkbookData;

戻り値

Excel.Interfaces.WorkbookData

イベントの詳細

onAutoSaveSettingChanged

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

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

イベントの種類

注釈