Excel. Workbook class

使用元

例

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

プロパティ

application	このブックを含む Excel アプリケーションインスタンスを表します。
autoSave	ブックが自動保存モードかどうかを指定します。
bindings	ブックの一部であるバインドのコレクションを表します。
calculationEngineVersion	Excel 計算エンジンのバージョンとして数字を返します。
chartDataPointTrack	関連付けられている実際のデータポイントをブックの全グラフが追跡している場合、true となります。グラフがデータポイントのインデックスを追跡する場合は false。
comments	ブックに関連付けられているコメントのコレクションを表します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
customXmlParts	このブックに含まれるカスタム XML パーツのコレクションを表します。
dataConnections	ブック内のすべてのデータ接続を表します。
externalCodeServiceTimeout	外部コードサービスに依存する数式の完了に割り当てられる最大時間 (秒) を指定します。有効な範囲は 1 - 86400 です。
functions	計算に使用できるワークシート関数のコレクションを表します。
isDirty	ブックが最後に保存されてから変更が行われたかどうかを指定します。変更したブックを保存せずに、または保存を求めるメッセージが表示されずに閉じる場合は、このプロパティを `true` に設定できます。
linkedEntityDataDomains	ブックで使用可能なリンクされたエンティティデータドメインのコレクションを返します。
linkedWorkbooks	リンクされたブックのコレクションを返します。数式では、ブックのリンクを使用して、現在のブックの外部のデータ (セルの値と名前) を参照できます。
localImage	ブックに関連付けられている `LocalImage` オブジェクトを返します。
name	ブックの名前を取得します。
names	ブックスコープの名前付き項目 (名前付き範囲と定数) のコレクションを表します。
notes	ブック内のすべてのノートオブジェクトのコレクションを返します。
pivotTables	ブックに関連付けられているピボットテーブルのコレクションを表します。
pivotTableStyles	ブックに関連付けられている PivotTableStyle のコレクションを表します。
previouslySaved	ブックがローカルまたはオンラインのどちらに保存されたことがあるかを指定します。
properties	ブックのプロパティを取得します。
protection	ブックの保護オブジェクトを返します。
queries	ブックの一部である Power Query クエリのコレクションを返します。
readOnly	ブックが読み取り専用モードで開かれている場合は `true` を返します。
sensitivityLabel	ブックの秘密度ラベルを返します。
settings	ブックに関連付けられている設定のコレクションを表します。
showPivotFieldList	ピボットテーブルのフィールドリストウィンドウをブックレベルで表示するかどうかを指定します。
slicers	ブックに関連付けられているスライサーのコレクションを表します。
slicerStyles	ブックに関連付けられている SlicerStyle のコレクションを表します。
styles	ブックに関連付けられているスタイルのコレクションを表します。
tables	ブックに関連付けられているテーブルのコレクションを表します。
tableStyles	ブックに関連付けられている TableStyle のコレクションを表します。
tasks	ブックに存在するタスクのコレクションを返します。
timelineStyles	ブックに関連付けられている TimelineStyle のコレクションを表します。
use1904DateSystem	ブックの日付を 1904 年から計算する場合、true となります。
usePrecisionAsDisplayed	ブックを表示桁数でのみ計算する場合、true となります。このプロパティを `false` から `true` に切り替えると、データの精度が完全に失われます。
worksheets	ブックに関連付けられているワークシートのコレクションを表します。

メソッド

autorunEventCompleted(AutorunEventCompletedOptions)	自動実行イベントでアドインのコードの実行が終了したことをホストアプリケーションに通知します。
close(closeBehavior)	現在のブックを閉じます。
close(closeBehavior)	現在のブックを閉じます。
focus()	ブックにフォーカスを設定します。これにより、Excel グリッドまたは現在アクティブなオブジェクトがキーボードイベントを受け取るようになります。
getActiveCell()	ブックで現在アクティブなセルを取得します。
getActiveChart()	ブックで現在アクティブになっているグラフを取得します。アクティブなグラフがない場合は、 `ItemNotFound` 例外がスローされます。
getActiveChartOrNullObject()	ブックで現在アクティブになっているグラフを取得します。アクティブなグラフがない場合、このメソッドは `isNullObject` プロパティが `true` に設定されたオブジェクトを返します。詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getActiveShape()	ブック内のアクティブな図形を取得します。アクティブな図形がない場合は `ItemNotFound` エラーをスローします。
getActiveShapeOrNullObject()	ブック内のアクティブな図形を取得します。アクティブな図形がない場合、このメソッドは `isNullObject` プロパティが `true` に設定されたオブジェクトを返します。詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getActiveSlicer()	ブックで現在アクティブになっているスライサーを取得します。アクティブなスライサーがない場合は、 `ItemNotFound` 例外がスローされます。
getActiveSlicerOrNullObject()	ブックで現在アクティブになっているスライサーを取得します。アクティブなスライサーがない場合、このメソッドは `isNullObject` プロパティが `true` に設定されたオブジェクトを返します。詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getIsActiveCollabSession()	ブックが複数のユーザーによって (共同編集により) 編集されている場合は `true` を返します。ブックの状態が変更されてから、その変更がメソッドの結果に反映されるまでに多少の時間がかかる場合があることに注意してください。
getLinkedEntityCellValue(linkedEntityCellValueId)	指定された`LinkedEntityId`に基づいて`LinkedEntityCellValue`を返します。
getSelectedRange()	現在選択されている単一の範囲をブックから取得します。複数の範囲が選択されている場合、このメソッドはエラーをスローします。
getSelectedRanges()	ブックから現在選択されている 1 つまたは複数の範囲を取得します。 `getSelectedRange()` とは異なり、このメソッドは、選択したすべての範囲を表す `RangeAreas` オブジェクトを返します。
inPreviewMode()	ブックが現在プレビューモードであるかどうかを返します。
insertWorksheetsFromBase64(base64File, options)	指定したワークシートをソースブックから現在のブックに挿入します。 `extensionHardening` Windows レジストリキーは、この API に影響します。 `base64File` パラメーターによって定義されたファイル拡張子は、挿入されたファイルの実際のファイルの種類と一致する必要があります。 `extensionHardening`が不一致を拒否するように設定されており、ファイル拡張子が実際のファイルの種類と一致しない場合、この API は次のエラーをスローします: "拡張子の強化ポリシーにより、この操作は許可されていません。"
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
save(saveBehavior)	現在のブックを保存します。
save(saveBehavior)	現在のブックを保存します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.Workbook` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.WorkbookData` と型指定) を返します。

イベント

onActivated	ブックがアクティブ化されたときに発生します。注: ブックが開かれたときに、このイベントは発生しません。
onAutoSaveSettingChanged	ブックの自動保存設定が変更されたときに発生します。
onSelectionChanged	ドキュメント内で選択が変更されるときに発生します。

application

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

readonly application: Excel.Application;

プロパティ値

Excel.Application

注釈

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

注釈

externalCodeServiceTimeout

注意

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

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

externalCodeServiceTimeout: number;

プロパティ値

number

注釈

functions

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

readonly functions: Excel.Functions;

プロパティ値

Excel.Functions

注釈

API セット: ExcelApi 1.2

isDirty

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

isDirty: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiOnline 1.1

linkedEntityDataDomains

ブックで使用可能なリンクされたエンティティデータドメインのコレクションを返します。

readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;

プロパティ値

Excel.LinkedEntityDataDomainCollection

注釈

API セット: ExcelApi 1.19

linkedWorkbooks

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

readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;

プロパティ値

Excel.LinkedWorkbookCollection

注釈

localImage

注意

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

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

readonly localImage: Excel.LocalImage;

プロパティ値

Excel.LocalImage

注釈

name

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

readonly name: string;

プロパティ値

string

注釈

names

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

readonly names: Excel.NamedItemCollection;

プロパティ値

Excel.NamedItemCollection

注釈

notes

ブック内のすべてのノートオブジェクトのコレクションを返します。

readonly notes: Excel.NoteCollection;

プロパティ値

Excel.NoteCollection

注釈

API セット: ExcelApi 1.18

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

注釈

queries

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

readonly queries: Excel.QueryCollection;

プロパティ値

Excel.QueryCollection

注釈

API セット: ExcelApi 1.14

readOnly

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

readonly readOnly: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.8

sensitivityLabel

注意

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

ブックの秘密度ラベルを返します。

readonly sensitivityLabel: Excel.SensitivityLabel;

プロパティ値

Excel.SensitivityLabel

注釈

settings

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

readonly settings: Excel.SettingCollection;

プロパティ値

Excel.SettingCollection

注釈

API セット: ExcelApi 1.4

showPivotFieldList

注意

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

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

showPivotFieldList: boolean;

プロパティ値

boolean

注釈

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

注釈

tasks

注意

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

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

readonly tasks: Excel.DocumentTaskCollection;

プロパティ値

Excel.DocumentTaskCollection

注釈

timelineStyles

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

readonly timelineStyles: Excel.TimelineStyleCollection;

プロパティ値

Excel.TimelineStyleCollection

注釈

use1904DateSystem

注意

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

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

use1904DateSystem: boolean;

プロパティ値

boolean

注釈

usePrecisionAsDisplayed

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

usePrecisionAsDisplayed: boolean;

プロパティ値

boolean

注釈

worksheets

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

readonly worksheets: Excel.WorksheetCollection;

プロパティ値

Excel.WorksheetCollection

注釈

autorunEventCompleted(AutorunEventCompletedOptions)

注意

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

自動実行イベントでアドインのコードの実行が終了したことをホストアプリケーションに通知します。

autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions): void;

パラメーター

AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions

必須です。自動実行イベントを完了するためのオプション。

返品

void

注釈

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

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

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

パラメーター

closeBehavior: "Save" | "SkipSave"

ブックを閉じる動作。

返品

void

注釈

API セット: ExcelApiDesktop 1.1

focus()

ブックにフォーカスを設定します。これにより、Excel グリッドまたは現在アクティブなオブジェクトがキーボードイベントを受け取るようになります。

focus(): void;

返品

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

注釈

getActiveShape()

ブック内のアクティブな図形を取得します。アクティブな図形がない場合は ItemNotFound エラーをスローします。

getActiveShape(): Excel.Shape;

返品

Excel.Shape

注釈

API セット: ExcelApi 1.19

getActiveShapeOrNullObject()

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

getActiveShapeOrNullObject(): Excel.Shape;

返品

Excel.Shape

注釈

API セット: ExcelApi 1.19

例

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

// This method gets the active shape and displays it as an image in the task pane.
await Excel.run(async (context) => {
  // Get the currently active shape, if any.
  const activeShape = context.workbook.getActiveShapeOrNullObject();
  
  if (activeShape) {
    // Convert the active shape to an image.
    const shapeImage = activeShape.getAsImage(Excel.PictureFormat.png);
    await context.sync();
    
    // Display the image in the task pane.
    const imageContainer = document.getElementById("image");
    imageContainer.innerHTML = ''; // Clear the container before adding a new image.
    const imageElement = document.createElement("img");
    imageElement.src = "data:image/png;base64," + shapeImage.value;
    imageContainer.appendChild(imageElement);              
  } else {
    console.log("No active shape");
  }
});

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>

注釈

OfficeExtension.ClientResult<Excel.LinkedEntityCellValue>

getLinkedEntityCellValue(linkedEntityCellValueId)

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

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

パラメーター

linkedEntityCellValueId: Excel.LinkedEntityId

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

返品

注釈

API セット: ExcelApi 1.16

getSelectedRange()

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

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

inPreviewMode()

注意

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

ブックが現在プレビューモードであるかどうかを返します。

inPreviewMode(): OfficeExtension.ClientResult<boolean>;

返品

OfficeExtension.ClientResult<boolean>

注釈

insertWorksheetsFromBase64(base64File, options)

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

extensionHardening Windows レジストリキーは、この API に影響します。 base64File パラメーターによって定義されたファイル拡張子は、挿入されたファイルの実際のファイルの種類と一致する必要があります。 extensionHardeningが不一致を拒否するように設定されており、ファイル拡張子が実際のファイルの種類と一致しない場合、この API は次のエラーをスローします: "拡張子の強化ポリシーにより、この操作は許可されていません。"

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

パラメーター

base64File: string

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

options: Excel.InsertWorksheetOptions

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

返品

OfficeExtension.ClientResult<string[]>

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

注釈

API セット: ExcelApi 1.13

この API は現在、Windows 版、Mac 版、Web 版の Office でのみサポートされています。 Excel on the web では、この API はグラフ、コメント、ピボットテーブル、またはスライサーの挿入をサポートしていません。

例

// 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 = document.getElementById("file") as HTMLInputElement;
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

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

返品

Excel.Workbook

load(propertyNames)

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

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

パラメーター

propertyNames: string | string[]

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

返品

Excel.Workbook

load(propertyNamesAndPaths)

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

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" または "Prompt" である必要があります。既定値は "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(saveBehavior)

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

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

パラメーター

saveBehavior: "Save" | "Prompt"

保存動作は "Save" または "Prompt" である必要があります。既定値は "Save" です。

返品

void

注釈

OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>

set(properties, options)

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

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

パラメーター

properties: Excel.Interfaces.WorkbookUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

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

返品

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

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

イベントの種類

OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>

注釈