Excel.Workbook class

Workbook は、ワークシート、テーブル、範囲などの関連するブック オブジェクトを含む最上位オブジェクトです。Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

application

このブックを含む Excel アプリケーションインスタンスを表します。Represents the Excel application instance that contains this workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

autoSave

ブックが自動保存モードかどうかを指定します。Specifies whether or not the workbook is in autosave mode. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

bindings

ブックの一部であるバインドのコレクションを表します。Represents a collection of bindings that are part of the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

calculationEngineVersion

Excel 計算エンジンのバージョンとして数字を返します。Returns a number about the version of Excel Calculation Engine. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

chartDataPointTrack

関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。True if all charts in the workbook are tracking the actual data points to which they are attached. False の場合、グラフはデータポイントのインデックスを追跡します。False if the charts track the index of the data points.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

comments

ブックに関連付けられているコメントの集まりを表します。Represents a collection of Comments associated with the workbook. 読み取り専用です。Read-only.

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

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

customXmlParts

このブックに格納されているカスタム XML パーツのコレクションを表します。Represents the collection of custom XML parts contained by this workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.5][ API set: ExcelApi 1.5 ]

dataConnections

ブック内のすべてのデータ接続を表します。Represents all data connections in the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

functions

計算に使用できるワークシート関数のコレクションを表します。Represents a collection of worksheet functions that can be used for computation. 読み取り専用です。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

isDirty

ブックが最後に保存された後に変更が行われたかどうかを指定します。Specifies whether or not changes have been made since the workbook was last saved. 変更したブックを保存しない、または保存するかどうかを確認するダイアログボックスを非表示にして閉じる場合は、このプロパティを true に設定しておくことができます。You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

name

ブックの名前を取得します。Gets the workbook name. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

names

ブック スコープの名前付き項目 (名前付き範囲と名前付き定数) のコレクションを表します。Represents a collection of workbook scoped named items (named ranges and constants). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

pivotTables

ブックに関連付けられているピボットテーブルのコレクションを表します。Represents a collection of PivotTables associated with the workbook. 読み取り専用。Read-only.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

pivotTableStyles

ブックに関連付けられている PivotTableStyle のコレクションを表します。Represents a collection of PivotTableStyles associated with the workbook. 読み取り専用です。Read-only.

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

previouslySaved

ブックがローカル環境またはオンライン環境に保存されたかどうかを指定します。Specifies whether or not the workbook has ever been saved locally or online. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

properties

ブックのプロパティを取得します。Gets the workbook properties. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

protection

ブックの workbookProtection オブジェクトを返します。Returns workbook protection object for a workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readOnly

true の場合、ブックが読み取り専用モードで開かれます。True if the workbook is open in Read-only mode. 読み取り専用です。Read-only.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

settings

ブックに関連付けられている Setting のコレクションを表します。Represents a collection of Settings associated with the workbook. 読み取り専用。Read-only.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

slicers

ブックに関連付けられているスライサーの集まりを表します。Represents a collection of Slicers associated with the workbook. 読み取り専用です。Read-only.

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

slicerStyles

ブックに関連付けられている SlicerStyle のコレクションを表します。Represents a collection of SlicerStyles associated with the workbook. 読み取り専用です。Read-only.

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

styles

ブックに関連付けられているスタイルのコレクションを表します。Represents a collection of styles associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

tables

ブックに関連付けられているテーブルのコレクションを表します。Represents a collection of tables associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

tableStyles

ブックに関連付けられている TableStyle のコレクションを表します。Represents a collection of TableStyles associated with the workbook. 読み取り専用です。Read-only.

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

timelineStyles

ブックに関連付けられている TimelineStyle のコレクションを表します。Represents a collection of TimelineStyles associated with the workbook. 読み取り専用です。Read-only.

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

use1904DateSystem

ブックの日付を 1904 年から計算する場合、true となります。True if the workbook uses the 1904 date system.

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

usePrecisionAsDisplayed

ブックを表示桁数でのみ計算する場合、true となります。True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. このプロパティを false から true に切り替えた場合、データは完全に正確に失われます。Data will permanently lose accuracy when switching this property from false to true.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

worksheets

ブックに関連付けられているワークシートのコレクションを表します。Represents a collection of worksheets associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

メソッド

close(closeBehavior)

現在のブックを閉じます。Close current workbook.

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

close(closeBehaviorString)

現在のブックを閉じます。Close current workbook.

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

getActiveCell()

ブックで現在アクティブなセルを取得します。Gets the currently active cell from the workbook.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getActiveChart()

ブックで現在アクティブになっているグラフを取得します。Gets the currently active chart in the workbook. アクティブなグラフがない場合は、 ItemNotFound例外がスローされます。If there is no active chart, an ItemNotFound exception is thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getActiveChartOrNullObject()

ブックで現在アクティブになっているグラフを取得します。Gets the currently active chart in the workbook. アクティブなグラフがない場合は、null オブジェクトが返されます。If there is no active chart, a null object is returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getActiveSlicer()

ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブなスライサーがない場合は、 ItemNotFound例外がスローされます。If there is no active slicer, an ItemNotFound exception is thrown.

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

getActiveSlicerOrNullObject()

ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブになっているスライサーがない場合、null オブジェクトが返されます。If there is no active slicer, a null object is returned.

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

getIsActiveCollabSession()

ブックが複数のユーザーによって編集されている場合 (共同編集)、true となります。True if the workbook is being edited by multiple users (co-authoring). ブックの状態が変更されたときと、メソッドの結果に変更が反映されるまでには、多少の時間がかかる場合があるのでご注意ください。Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSelectedRange()

ブックから現在選択されている1つのセル範囲を取得します。Gets the currently selected single range from the workbook. 複数の範囲が選択されている場合、このメソッドはエラーをスローします。If there are multiple ranges selected, this method will throw an error.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getSelectedRanges()

ブックから現在選択されている 1 つまたは複数の範囲を取得します。Gets the currently selected one or more ranges from the workbook. getSelectedRange() の場合と同様に、このメソッドは、選択されているすべての範囲を表す RangeAreas オブジェクトを返します。Unlike getSelectedRange(), this method returns a RangeAreas object that represents all the selected ranges.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

save(saveBehavior)

現在のブックを保存します。Save current workbook.

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

save(saveBehaviorString)

現在のブックを保存します。Save current workbook.

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

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元のブックのオブジェクトは API オブジェクトであるのに対しtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorkbookData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Workbook object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

イベント

onAutoSaveSettingChanged

ブックで autoSave の設定が変更されると発生します。Occurs when the autoSave setting is changed on the workbook.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

onSelectionChanged

ドキュメント内で選択が変更されるときに発生します。Occurs when the selection in the document is changed.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

プロパティの詳細

application

このブックを含む Excel アプリケーションインスタンスを表します。Represents the Excel application instance that contains this workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly application: Excel.Application;

プロパティ値

autoSave

ブックが自動保存モードかどうかを指定します。Specifies whether or not the workbook is in autosave mode. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly autoSave: boolean;

プロパティ値

boolean

bindings

ブックの一部であるバインドのコレクションを表します。Represents a collection of bindings that are part of the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly bindings: Excel.BindingCollection;

プロパティ値

calculationEngineVersion

Excel 計算エンジンのバージョンとして数字を返します。Returns a number about the version of Excel Calculation Engine. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly calculationEngineVersion: number;

プロパティ値

number

chartDataPointTrack

関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。True if all charts in the workbook are tracking the actual data points to which they are attached. False の場合、グラフはデータポイントのインデックスを追跡します。False if the charts track the index of the data points.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

chartDataPointTrack: boolean;

プロパティ値

boolean

comments

注意

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

ブックに関連付けられているコメントの集まりを表します。Represents a collection of Comments associated with the workbook. 読み取り専用です。Read-only.

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

readonly comments: Excel.CommentCollection;

プロパティ値

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

customXmlParts

このブックに格納されているカスタム XML パーツのコレクションを表します。Represents the collection of custom XML parts contained by this workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.5][ API set: ExcelApi 1.5 ]

readonly customXmlParts: Excel.CustomXmlPartCollection;

プロパティ値

dataConnections

ブック内のすべてのデータ接続を表します。Represents all data connections in the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly dataConnections: Excel.DataConnectionCollection;

プロパティ値

functions

計算に使用できるワークシート関数のコレクションを表します。Represents a collection of worksheet functions that can be used for computation. 読み取り専用です。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

readonly functions: Excel.Functions;

プロパティ値

isDirty

ブックが最後に保存された後に変更が行われたかどうかを指定します。Specifies whether or not changes have been made since the workbook was last saved. 変更したブックを保存しない、または保存するかどうかを確認するダイアログボックスを非表示にして閉じる場合は、このプロパティを true に設定しておくことができます。You can set this property to true if you want to close a modified workbook without either saving it or being prompted to save it.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isDirty: boolean;

プロパティ値

boolean

name

ブックの名前を取得します。Gets the workbook name. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly name: string;

プロパティ値

string

names

ブック スコープの名前付き項目 (名前付き範囲と名前付き定数) のコレクションを表します。Represents a collection of workbook scoped named items (named ranges and constants). 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly names: Excel.NamedItemCollection;

プロパティ値

pivotTables

ブックに関連付けられているピボットテーブルのコレクションを表します。Represents a collection of PivotTables associated with the workbook. 読み取り専用。Read-only.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

readonly pivotTables: Excel.PivotTableCollection;

プロパティ値

pivotTableStyles

注意

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

ブックに関連付けられている PivotTableStyle のコレクションを表します。Represents a collection of PivotTableStyles associated with the workbook. 読み取り専用です。Read-only.

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

プロパティ値

previouslySaved

ブックがローカル環境またはオンライン環境に保存されたかどうかを指定します。Specifies whether or not the workbook has ever been saved locally or online. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly previouslySaved: boolean;

プロパティ値

boolean

properties

ブックのプロパティを取得します。Gets the workbook properties. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly properties: Excel.DocumentProperties;

プロパティ値

Examples

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

ブックの workbookProtection オブジェクトを返します。Returns workbook protection object for a workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly protection: Excel.WorkbookProtection;

プロパティ値

readOnly

true の場合、ブックが読み取り専用モードで開かれます。True if the workbook is open in Read-only mode. 読み取り専用です。Read-only.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly readOnly: boolean;

プロパティ値

boolean

settings

ブックに関連付けられている Setting のコレクションを表します。Represents a collection of Settings associated with the workbook. 読み取り専用。Read-only.

[API セット: excelapi 1.4][ API set: ExcelApi 1.4 ]

readonly settings: Excel.SettingCollection;

プロパティ値

slicers

注意

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

ブックに関連付けられているスライサーの集まりを表します。Represents a collection of Slicers associated with the workbook. 読み取り専用です。Read-only.

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

readonly slicers: Excel.SlicerCollection;

プロパティ値

slicerStyles

注意

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

ブックに関連付けられている SlicerStyle のコレクションを表します。Represents a collection of SlicerStyles associated with the workbook. 読み取り専用です。Read-only.

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

readonly slicerStyles: Excel.SlicerStyleCollection;

プロパティ値

styles

ブックに関連付けられているスタイルのコレクションを表します。Represents a collection of styles associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly styles: Excel.StyleCollection;

プロパティ値

tables

ブックに関連付けられているテーブルのコレクションを表します。Represents a collection of tables associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly tables: Excel.TableCollection;

プロパティ値

tableStyles

注意

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

ブックに関連付けられている TableStyle のコレクションを表します。Represents a collection of TableStyles associated with the workbook. 読み取り専用です。Read-only.

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

readonly tableStyles: Excel.TableStyleCollection;

プロパティ値

timelineStyles

注意

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

ブックに関連付けられている TimelineStyle のコレクションを表します。Represents a collection of TimelineStyles associated with the workbook. 読み取り専用です。Read-only.

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

readonly timelineStyles: Excel.TimelineStyleCollection;

プロパティ値

use1904DateSystem

注意

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

ブックの日付を 1904 年から計算する場合、true となります。True if the workbook uses the 1904 date system.

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

use1904DateSystem: boolean;

プロパティ値

boolean

usePrecisionAsDisplayed

ブックを表示桁数でのみ計算する場合、true となります。True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. このプロパティを false から true に切り替えた場合、データは完全に正確に失われます。Data will permanently lose accuracy when switching this property from false to true.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

usePrecisionAsDisplayed: boolean;

プロパティ値

boolean

worksheets

ブックに関連付けられているワークシートのコレクションを表します。Represents a collection of worksheets associated with the workbook. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

メソッドの詳細

close(closeBehavior)

注意

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

現在のブックを閉じます。Close current workbook.

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

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

パラメーター

closeBehavior
Excel.CloseBehavior

ブックのクローズの動作workbook close behavior.

戻り値

void

Examples

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

close(closeBehaviorString)

注意

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

現在のブックを閉じます。Close current workbook.

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

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

パラメーター

closeBehaviorString
"Save" | "SkipSave"

ブックのクローズの動作workbook close behavior.

戻り値

void

getActiveCell()

ブックで現在アクティブなセルを取得します。Gets the currently active cell from the workbook.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getActiveCell(): Excel.Range;

戻り値

Examples

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

ブックで現在アクティブになっているグラフを取得します。Gets the currently active chart in the workbook. アクティブなグラフがない場合は、 ItemNotFound例外がスローされます。If there is no active chart, an ItemNotFound exception is thrown.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getActiveChart(): Excel.Chart;

戻り値

getActiveChartOrNullObject()

ブックで現在アクティブになっているグラフを取得します。Gets the currently active chart in the workbook. アクティブなグラフがない場合は、null オブジェクトが返されます。If there is no active chart, a null object is returned.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getActiveChartOrNullObject(): Excel.Chart;

戻り値

getActiveSlicer()

注意

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

ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブなスライサーがない場合は、 ItemNotFound例外がスローされます。If there is no active slicer, an ItemNotFound exception is thrown.

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

getActiveSlicer(): Excel.Slicer;

戻り値

getActiveSlicerOrNullObject()

注意

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

ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブになっているスライサーがない場合、null オブジェクトが返されます。If there is no active slicer, a null object is returned.

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

getActiveSlicerOrNullObject(): Excel.Slicer;

戻り値

getIsActiveCollabSession()

ブックが複数のユーザーによって編集されている場合 (共同編集)、true となります。True if the workbook is being edited by multiple users (co-authoring). ブックの状態が変更されたときと、メソッドの結果に変更が反映されるまでには、多少の時間がかかる場合があるのでご注意ください。Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

戻り値

OfficeExtension.ClientResult<boolean>

getSelectedRange()

ブックから現在選択されている1つのセル範囲を取得します。Gets the currently selected single range from the workbook. 複数の範囲が選択されている場合、このメソッドはエラーをスローします。If there are multiple ranges selected, this method will throw an error.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getSelectedRange(): Excel.Range;

戻り値

Examples

Excel.run(function (ctx) { 
    var selectedRange = ctx.workbook.getSelectedRange();
    selectedRange.load('address');
    return ctx.sync().then(function() {
            console.log(selectedRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getSelectedRanges()

ブックから現在選択されている 1 つまたは複数の範囲を取得します。Gets the currently selected one or more ranges from the workbook. getSelectedRange() の場合と同様に、このメソッドは、選択されているすべての範囲を表す RangeAreas オブジェクトを返します。Unlike getSelectedRange(), this method returns a RangeAreas object that represents all the selected ranges.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getSelectedRanges(): Excel.RangeAreas;

戻り値

Examples

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

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

    await context.sync();
})

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Workbook-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Workbook - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Workbook-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Workbook - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Workbook-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Workbook - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

save(saveBehavior)

注意

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

現在のブックを保存します。Save current workbook.

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

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

パラメーター

saveBehavior
Excel.SaveBehavior

ブックの保存動作。workbook save behavior.

戻り値

void

Examples

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

save(saveBehaviorString)

注意

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

現在のブックを保存します。Save current workbook.

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

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

パラメーター

saveBehaviorString
"Save" | "Prompt"

ブックの保存動作。workbook save behavior.

戻り値

void

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.WorkbookUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Workbook): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Workbook): void;

パラメーター

properties
Excel.Workbook

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元のブックのオブジェクトは API オブジェクトであるのに対しtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorkbookData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Workbook object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorkbookData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WorkbookData;

戻り値

イベントの詳細

onAutoSaveSettingChanged

ブックで autoSave の設定が変更されると発生します。Occurs when the autoSave setting is changed on the workbook.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

戻り値

OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>

onSelectionChanged

ドキュメント内で選択が変更されるときに発生します。Occurs when the selection in the document is changed.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

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

戻り値

OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>