次の方法で共有


Excel.Workbook class

ブックは、ワークシート、テーブル、範囲などの関連するブック オブジェクトを含む最上位のオブジェクトです。 ブック オブジェクト モデルの詳細については、「 Excel JavaScript API を使用してブックを操作する」を参照してください。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

application

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

autoSave

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

bindings

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

calculationEngineVersion

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

chartDataPointTrack

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

comments

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

context

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

customXmlParts

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

dataConnections

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

externalCodeServiceTimeout

外部コード サービスに依存する数式が完了するまでに割り当てられる最大時間を秒単位で指定します。 有効な範囲は、1 から 86400 までです。

functions

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

isDirty

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

linkedDataTypes

ブックの一部であるリンクされたデータ型のコレクションを返します。

linkedWorkbooks

リンクされたブックのコレクションを返します。 数式では、ブック リンクを使用して、現在のブックの外部にあるデータ (セル値と名前) を参照できます。

localImage

ブックに LocalImage 関連付けられているオブジェクトを返します。

name

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

names

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

pivotTables

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

pivotTableStyles

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

previouslySaved

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

properties

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

protection

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

queries

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

readOnly

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

settings

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

showPivotFieldList

ピボットテーブルのフィールド リスト ペインをブック レベルで表示するかどうかを指定します。

slicers

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

slicerStyles

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

styles

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

tables

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

tableStyles

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

tasks

ブックに存在するタスクのコレクションを返します。

timelineStyles

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

use1904DateSystem

ブックの日付を 1904 年から計算する場合、true となります。

usePrecisionAsDisplayed

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

worksheets

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

メソッド

close(closeBehavior)

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

close(closeBehaviorString)

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

getActiveCell()

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

getActiveChart()

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

getActiveChartOrNullObject()

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

getActiveSlicer()

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

getActiveSlicerOrNullObject()

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

getIsActiveCollabSession()

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

getLinkedEntityCellValue(linkedEntityCellValueId)

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

getSelectedRange()

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

getSelectedRanges()

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

insertWorksheetsFromBase64(base64File, options)

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

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

save(saveBehavior)

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

save(saveBehaviorString)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

イベント

onActivated

ブックがアクティブになると発生します。 注: このイベントは、ブックを開いたときに発生しません。

onAutoSaveSettingChanged

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

onSelectionChanged

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

プロパティの詳細

application

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

readonly application: Excel.Application;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

autoSave

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

readonly autoSave: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

bindings

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

readonly bindings: Excel.BindingCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

calculationEngineVersion

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

readonly calculationEngineVersion: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

chartDataPointTrack

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

chartDataPointTrack: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

comments

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

readonly comments: Excel.CommentCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

context

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

context: RequestContext;

プロパティ値

customXmlParts

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

readonly customXmlParts: Excel.CustomXmlPartCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.5 ]

dataConnections

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

readonly dataConnections: Excel.DataConnectionCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

externalCodeServiceTimeout

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

外部コード サービスに依存する数式が完了するまでに割り当てられる最大時間を秒単位で指定します。 有効な範囲は、1 から 86400 までです。

externalCodeServiceTimeout: number;

プロパティ値

number

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

functions

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

readonly functions: Excel.Functions;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

isDirty

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

isDirty: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

linkedDataTypes

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックの一部であるリンクされたデータ型のコレクションを返します。

readonly linkedDataTypes: Excel.LinkedDataTypeCollection;

プロパティ値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

linkedWorkbooks

リンクされたブックのコレクションを返します。 数式では、ブック リンクを使用して、現在のブックの外部にあるデータ (セル値と名前) を参照できます。

readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;

プロパティ値

注釈

[ API セット: ExcelApiOnline 1.1 ]

localImage

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックに LocalImage 関連付けられているオブジェクトを返します。

readonly localImage: Excel.LocalImage;

プロパティ値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

name

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

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

names

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

readonly names: Excel.NamedItemCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

pivotTables

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

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

pivotTableStyles

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

previouslySaved

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

readonly previouslySaved: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

properties

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

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

protection

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

readonly protection: Excel.WorkbookProtection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

queries

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

readonly queries: Excel.QueryCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.14 ]

readOnly

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

readonly readOnly: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

settings

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

readonly settings: Excel.SettingCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.4 ]

showPivotFieldList

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ピボットテーブルのフィールド リスト ペインをブック レベルで表示するかどうかを指定します。

showPivotFieldList: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

slicers

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

readonly slicers: Excel.SlicerCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

slicerStyles

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

readonly slicerStyles: Excel.SlicerStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

styles

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

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

tables

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

readonly tables: Excel.TableCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

tableStyles

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

readonly tableStyles: Excel.TableStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

tasks

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックに存在するタスクのコレクションを返します。

readonly tasks: Excel.DocumentTaskCollection;

プロパティ値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

timelineStyles

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

readonly timelineStyles: Excel.TimelineStyleCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

use1904DateSystem

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックの日付を 1904 年から計算する場合、true となります。

use1904DateSystem: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

usePrecisionAsDisplayed

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

usePrecisionAsDisplayed: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

worksheets

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

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

close(closeBehavior)

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

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

パラメーター

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)

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

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

パラメーター

closeBehaviorString

"Save" | "SkipSave"

ブックの閉じる動作。

戻り値

void

注釈

[ API セット: ExcelApi 1.11 ]

getActiveCell()

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

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

getActiveChart()

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

getActiveChart(): Excel.Chart;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getActiveChartOrNullObject()

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

getActiveChartOrNullObject(): Excel.Chart;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getActiveSlicer()

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

getActiveSlicer(): Excel.Slicer;

戻り値

注釈

[ API セット: ExcelApi 1.10 ]

getActiveSlicerOrNullObject()

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

getActiveSlicerOrNullObject(): Excel.Slicer;

戻り値

注釈

[ API セット: ExcelApi 1.10 ]

getIsActiveCollabSession()

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

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

getLinkedEntityCellValue(linkedEntityCellValueId)

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

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

パラメーター

linkedEntityCellValueId
Excel.LinkedEntityId

個々 LinkedEntityCellValueの を指定する識別子。

戻り値

注釈

[ API セット: ExcelApi 1.16 ]

getSelectedRange()

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

getSelectedRanges()

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

insertWorksheetsFromBase64(base64File, options)

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

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

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

パラメーター

base64File

string

必須。 ソース ブック ファイルを表す base64 でエンコードされた文字列。

options
Excel.InsertWorksheetOptions

省略可能。 挿入するワークシートと、ブック内の新しいワークシートを挿入する場所を定義するオプション。 既定では、ソース ブックのすべてのワークシートが現在のブックの末尾に挿入されます。

戻り値

新しく挿入された各ワークシートに対応する 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();
});

load(options)

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

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

パラメーター

options
Excel.Interfaces.WorkbookLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

save(saveBehavior)

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

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

パラメーター

saveBehavior
Excel.SaveBehavior

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

戻り値

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

パラメーター

saveBehaviorString

"Save" | "Prompt"

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

戻り値

void

注釈

[ API セット: ExcelApi 1.11 ]

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

toJSON(): Excel.Interfaces.WorkbookData;

戻り値

イベントの詳細

onActivated

ブックがアクティブになると発生します。 注: このイベントは、ブックを開いたときに発生しません。

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

onAutoSaveSettingChanged

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

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

イベントの種類

注釈

[ API セット: ExcelApi 1.9 ]

onSelectionChanged

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

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

イベントの種類

注釈

[ API セット: ExcelApi 1.2 ]