ExcelScript.Workbook interface

パッケージ:

ExcelScript

ブックは、ワークシート、テーブル、範囲などの関連するブック オブジェクトを含む最上位のオブジェクトです。

注釈

例

/**
 * This script adds a new worksheet to the workbook, then switches to it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add a new worksheet with the default name.
  let worksheet = workbook.addWorksheet();

  // Switch focus to the new worksheet.
  worksheet.activate();
}

メソッド

addBinding(range, bindingType, id)	特定の範囲に新しいバインドを追加します。
addBindingFromNamedItem(name, bindingType, id)	ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。
addBindingFromSelection(bindingType, id)	現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。
addComment(cellAddress, content, contentType)	指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
addCustomXmlPart(xml)	ブックに新しいカスタム XML パーツを追加します。
addNamedItem(name, reference, comment)	指定のスコープのコレクションに新しい名前を追加します。
addNamedItemFormulaLocal(name, formula, comment)	ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。
addPivotTable(name, source, destination)	指定したソース データに基づいてピボットテーブルを追加し、変換先範囲の左上のセルに挿入します。
addPivotTableStyle(name, makeUniqueName)	指定した名前の空白の PivotTableStyle を作成します。
addPredefinedCellStyle(name)	コレクションに新しいスタイルを追加します。
addSlicer(slicerSource, sourceField, slicerDestination)	ブックに新しいスライサーを追加します。
addSlicerStyle(name, makeUniqueName)	指定した名前の空白スライサー スタイルを作成します。
addTable(address, hasHeaders)	新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。
addTableStyle(name, makeUniqueName)	指定した名前の空白の TableStyle を作成します。
addTimelineStyle(name, makeUniqueName)	指定した名前の空白の TimelineStyle を作成します。
addWorksheet(name)	新しいワークシートをブックに追加します。 ワークシートは、既存のワークシートの末尾に追加されます。 新しく追加したワークシートをアクティブ化する場合は、そのワークシート .activate() を呼び出します。
breakAllLinksToLinkedWorkbooks()	リンクされたブックへのリンクをすべて解除します。 リンクが破損すると、ブック リンクを参照するすべての数式が完全に削除され、最後に取得された値に置き換えられます。
getActiveCell()	ブックで現在アクティブなセルを取得します。
getActiveChart()	ブックで現在アクティブになっているグラフを取得します。 アクティブなグラフがない場合、このメソッドは undefinedを返します。
getActiveSlicer()	ブックで現在アクティブになっているスライサーを取得します。 アクティブなスライサーがない場合、このメソッドは undefinedを返します。
getActiveWorksheet()	ブックの、現在作業中のワークシートを取得します。
getApplication()	このブックを含む Excel アプリケーション インスタンスを表します。
getAutoSave()	ブックが自動保存モードかどうかを指定します。
getBinding(id)	ID を使用してバインド オブジェクトを取得します。 バインド オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getBindings()	ブックの一部であるバインドのコレクションを表します。
getCalculationEngineVersion()	Excel 計算エンジンのバージョンとして数字を返します。
getChartDataPointTrack()	関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。 False の場合、グラフは、データ ポイントのインデックスを追跡します。
getComment(commentId)	ID に基づいてコレクションからコメントを取得します。 コメント オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getCommentByCell(cellAddress)	指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。
getCommentByReplyId(replyId)	指定された応答が接続されているコメントを取得します。
getComments()	ブックに関連付けられているコメントのコレクションを表します。
getCustomXmlPart(id)	ID に基づいて、カスタム XML パーツを取得します。 CustomXmlPartが存在しない場合、このメソッドはundefinedを返します。
getCustomXmlPartByNamespace(namespaceUri)	名前空間が指定された名前空間と一致するカスタム XML パーツの新しいコレクションを取得します。
getCustomXmlParts()	このブックに含まれるカスタム XML パーツのコレクションを表します。
getCustomXmlPartsByNamespace(namespaceUri)	名前空間が指定された名前空間と一致するカスタム XML パーツの新しいコレクションを取得します。
getDefaultPivotTableStyle()	親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。
getDefaultSlicerStyle()	親オブジェクトのスコープの既定の SlicerStyle を取得します。
getDefaultTableStyle()	親オブジェクトのスコープの既定のテーブル スタイルを取得します。
getDefaultTimelineStyle()	親オブジェクトのスコープの既定のタイムライン スタイルを取得します。
getFirstWorksheet(visibleOnly)	コレクション内の最初のワークシートを取得します。
getIsDirty()	ブックが最後に保存されてから変更が加えられたかどうかを指定します。 このプロパティは、変更したブックを保存せずに閉じるか、保存するように求められる場合は、 true に設定できます。
getLastWorksheet(visibleOnly)	コレクション内の最後のワークシートを取得します。
getLinkedWorkbookByUrl(key)	リンクされたブックに関する情報を URL で取得します。 ブックが存在しない場合、このメソッドは undefinedを返します。
getLinkedWorkbookRefreshMode()	ブック リンクの更新モードを表します。 このモードは、ブックに存在するすべてのブック リンクで同じです。
getLinkedWorkbooks()	リンクされたブックのコレクションを返します。 数式では、ブック リンクを使用して、現在のブックの外部にあるデータ (セル値と名前) を参照できます。
getName()	ブックの名前を取得します。
getNamedItem(name)	名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getNames()	ブックスコープの名前付き項目 (名前付き範囲と定数) のコレクションを表します。
getPivotTable(name)	名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは undefinedを返します。
getPivotTables()	ブックに関連付けられているピボットテーブルのコレクションを表します。
getPivotTableStyle(name)	名前で PivotTableStyle を取得します。 PivotTableStyleが存在しない場合、このメソッドはundefinedを返します。
getPivotTableStyles()	ブックに関連付けられている PivotTableStyle のコレクションを表します。
getPredefinedCellStyle(name)	名前に基づいてスタイルを取得します。 style オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getPredefinedCellStyles()	ブックに関連付けられているスタイルのコレクションを表します。
getPreviouslySaved()	ブックがローカルまたはオンラインで保存されたかどうかを指定します。
getProperties()	ブックのプロパティを取得します。
getProtection()	ブックの保護オブジェクトを返します。
getQueries()	ブックの一部である Power Query クエリのコレクションを返します。
getQuery(key)	コレクションの名前に基づいてクエリを取得します。
getReadOnly()	ブックが読み取り専用モードで開いている場合は、 true を返します。
getSelectedRange()	ブックから現在選択されている 1 つの範囲を取得します。 複数の範囲が選択されている場合、このメソッドはエラーをスローします。
getSelectedRanges()	ブックから現在選択されている 1 つまたは複数の範囲を取得します。 getSelectedRange() とは異なり、このメソッドは、選択したすべての範囲を表すRangeAreas オブジェクトを返します。
getSlicer(key)	名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは undefinedを返します。
getSlicers()	ブックに関連付けられているスライサーのコレクションを表します。
getSlicerStyle(name)	名前で SlicerStyle を取得します。 スライサー スタイルが存在しない場合、このメソッドは undefinedを返します。
getSlicerStyles()	ブックに関連付けられている SlicerStyle のコレクションを表します。
getTable(key)	名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは undefinedを返します。
getTables()	ブックに関連付けられているテーブルのコレクションを表します。
getTableStyle(name)	名前で TableStyle を取得します。 テーブル スタイルが存在しない場合、このメソッドは undefinedを返します。
getTableStyles()	ブックに関連付けられている TableStyle のコレクションを表します。
getTimelineStyle(name)	名前で TimelineStyle を取得します。 タイムラインスタイルが存在しない場合、このメソッドは undefinedを返します。
getTimelineStyles()	ブックに関連付けられている TimelineStyle のコレクションを表します。
getUsePrecisionAsDisplayed()	ブックを表示桁数でのみ計算する場合、true となります。 このプロパティを false から true に切り替えると、データの精度が完全に失われます。
getWorksheet(key)	名前または ID を使用して、ワークシート オブジェクトを取得します。 ワークシートが存在しない場合、このメソッドは undefinedを返します。
getWorksheets()	ブックに関連付けられているワークシートのコレクションを表します。
refreshAllDataConnections()	すべてのデータ接続を更新します。
refreshAllLinksToLinkedWorkbooks()	すべてのブック リンクを更新するように要求します。
refreshAllPivotTables()	コレクション内のすべてのピボットテーブルを更新します。
setChartDataPointTrack(chartDataPointTrack)	関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。 False の場合、グラフは、データ ポイントのインデックスを追跡します。
setDefaultPivotTableStyle(newDefaultStyle)	親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。
setDefaultSlicerStyle(newDefaultStyle)	親オブジェクトのスコープで使用する既定のスライサー スタイルを設定します。
setDefaultTableStyle(newDefaultStyle)	親オブジェクトのスコープで使用する既定のテーブル スタイルを設定します。
setDefaultTimelineStyle(newDefaultStyle)	親オブジェクトのスコープで使用する既定のタイムライン スタイルを設定します。
setIsDirty(isDirty)	ブックが最後に保存されてから変更が加えられたかどうかを指定します。 このプロパティは、変更したブックを保存せずに閉じるか、保存するように求められる場合は、 true に設定できます。
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	ブック リンクの更新モードを表します。 このモードは、ブックに存在するすべてのブック リンクで同じです。
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	ブックを表示桁数でのみ計算する場合、true となります。 このプロパティを false から true に切り替えると、データの精度が完全に失われます。

メソッドの詳細

addBinding(range, bindingType, id)

特定の範囲に新しいバインドを追加します。

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

パラメーター

range

ExcelScript.Range | string

バインドをバインドする範囲です。 Range オブジェクトまたは文字列を指定できます。 文字列の場合は、シート名を含む完全なアドレスが含まれている必要があります

bindingType

ExcelScript.BindingType

バインドの種類。 ExcelScript.BindingType を参照してください。

id

string

バインドの名前。

戻り値

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

ブック内の名前付きアイテムに基づいて新しいバインドを追加します。 名前付き項目が複数の領域を参照している場合は、 InvalidReference エラーが返されます。

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

パラメーター

name

string

バインドの作成元の名前です。

bindingType

ExcelScript.BindingType

バインドの種類。 ExcelScript.BindingType を参照してください。

id

string

バインドの名前。

戻り値

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

現在の選択範囲に基づいて新しいバインドを追加します。 選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

パラメーター

bindingType

ExcelScript.BindingType

バインドの種類。 ExcelScript.BindingType を参照してください。

id

string

バインドの名前。

戻り値

ExcelScript.Binding

addComment(cellAddress, content, contentType)

指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

パラメーター

cellAddress

ExcelScript.Range | string

コメントが追加されるセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

content

ExcelScript.CommentRichContent | string

コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです。 文字列はプレーン テキストに使用されます。 CommentRichContent オブジェクトを使用すると、メンションなどの他のコメント機能を使用できます。

contentType

ExcelScript.ContentType

省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plainです。

戻り値

ExcelScript.Comment

addCustomXmlPart(xml)

ブックに新しいカスタム XML パーツを追加します。

addCustomXmlPart(xml: string): CustomXmlPart;

パラメーター

xml

string

XML コンテンツ。 有効な XML フラグメントである必要があります。

戻り値

ExcelScript.CustomXmlPart

addNamedItem(name, reference, comment)

指定のスコープのコレクションに新しい名前を追加します。

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

パラメーター

name

string

名前付きの項目の名前。

reference

ExcelScript.Range | string

名前が参照する数式または範囲。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

ExcelScript.NamedItem

例

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

addNamedItemFormulaLocal(name, formula, comment)

ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

パラメーター

name

string

名前付きの項目の名前。

formula

string

名前が参照するユーザーのロケールの数式。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

ExcelScript.NamedItem

addPivotTable(name, source, destination)

指定したソース データに基づいてピボットテーブルを追加し、変換先範囲の左上のセルに挿入します。

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

パラメーター

name

string

新しいピボットテーブルの名前。

source

ExcelScript.Range | string | ExcelScript.Table

新しいピボットテーブルのソース データは、範囲 (またはワークシート名を含む文字列アドレス) またはテーブルのいずれかです。

destination

ExcelScript.Range | string

ピボットテーブル レポートの配置先範囲 (結果のレポートを配置するワークシートの範囲) の左上端のセルを指定します。

戻り値

ExcelScript.PivotTable

例

/**
 * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addPivotTableStyle(name, makeUniqueName)

指定した名前の空白の PivotTableStyle を作成します。

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

パラメーター

name

string

新しいピボットテーブル スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーをスローします。

makeUniqueName

boolean

省略可能。 既定値は false です。 true 場合は、必要に応じて一意にするために、名前に番号を追加します。

戻り値

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

コレクションに新しいスタイルを追加します。

addPredefinedCellStyle(name: string): void;

パラメーター

name

string

追加するスタイルの名前。

戻り値

void

addSlicer(slicerSource, sourceField, slicerDestination)

ブックに新しいスライサーを追加します。

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

パラメーター

slicerSource

string | ExcelScript.PivotTable | ExcelScript.Table

新しいスライサーの基になるデータ ソース。 PivotTable オブジェクト、Table オブジェクト、または文字列を指定できます。 ピボットテーブル オブジェクトが渡されると、データ ソースは PivotTable オブジェクトのソースになります。 Table オブジェクトが渡されると、データ ソースは Table オブジェクトです。 文字列が渡されると、ピボットテーブルまたはテーブルの名前または ID として解釈されます。

sourceField

string | ExcelScript.PivotField | number | ExcelScript.TableColumn

フィルター処理するデータ ソースのフィールド。 PivotField オブジェクト、TableColumn オブジェクト、PivotFieldの ID、またはTableColumnの名前または ID を指定できます。

slicerDestination

string | ExcelScript.Worksheet

省略可能。 新しいスライサーが作成されるワークシート。 Worksheet オブジェクト、またはワークシートの名前または ID を指定できます。 スライサー コレクションがワークシートから取得される場合は、このパラメーターを省略できます。

戻り値

ExcelScript.Slicer

例

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

addSlicerStyle(name, makeUniqueName)

指定した名前の空白スライサー スタイルを作成します。

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

パラメーター

name

string

新しいスライサー スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument 例外をスローします。

makeUniqueName

boolean

省略可能。 既定値は false です。 true 場合は、必要に応じて一意にするために、名前に番号を追加します。

戻り値

ExcelScript.SlicerStyle

addTable(address, hasHeaders)

新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。

addTable(address: Range | string, hasHeaders: boolean): Table;

パラメーター

address

ExcelScript.Range | string

Range オブジェクト、またはデータ ソースを表す文字列アドレスまたは範囲の名前。 アドレスにシート名が含まれていない場合は、現在作業中のシートが使用されます。

hasHeaders

boolean

インポートされるデータに列ラベルがあるかどうかを示すブール値。 ソースにヘッダーが含まれていない場合 (つまり、このプロパティが false に設定されている場合)、Excel はヘッダーを自動的に生成し、データを 1 行ずつシフトします。

戻り値

ExcelScript.Table

例

/**
 * This sample converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

addTableStyle(name, makeUniqueName)

指定した名前の空白の TableStyle を作成します。

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

パラメーター

name

string

新しいテーブル スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーをスローします。

makeUniqueName

boolean

省略可能。 既定値は false です。 true 場合は、必要に応じて一意にするために、名前に番号を追加します。

戻り値

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

指定した名前の空白の TimelineStyle を作成します。

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

パラメーター

name

string

新しいタイムライン スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーをスローします。

makeUniqueName

boolean

省略可能。 既定値は false です。 true 場合は、必要に応じて一意にするために、名前に番号を追加します。

戻り値

ExcelScript.TimelineStyle

addWorksheet(name)

新しいワークシートをブックに追加します。 ワークシートは、既存のワークシートの末尾に追加されます。 新しく追加したワークシートをアクティブ化する場合は、そのワークシート .activate() を呼び出します。

addWorksheet(name?: string): Worksheet;

パラメーター

name

string

省略可能。 追加するワークシートの名前。 指定した場合、名前は一意である必要があります。 指定されていない場合は、Excel が新しいワークシートの名前を決定します。

戻り値

ExcelScript.Worksheet

例

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

breakAllLinksToLinkedWorkbooks()

リンクされたブックへのリンクをすべて解除します。 リンクが破損すると、ブック リンクを参照するすべての数式が完全に削除され、最後に取得された値に置き換えられます。

breakAllLinksToLinkedWorkbooks(): void;

戻り値

void

getActiveCell()

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

getActiveCell(): Range;

戻り値

ExcelScript.Range

例

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

ブックで現在アクティブになっているグラフを取得します。 アクティブなグラフがない場合、このメソッドは undefinedを返します。

getActiveChart(): Chart;

戻り値

ExcelScript.Chart

getActiveSlicer()

ブックで現在アクティブになっているスライサーを取得します。 アクティブなスライサーがない場合、このメソッドは undefinedを返します。

getActiveSlicer(): Slicer;

戻り値

ExcelScript.Slicer

getActiveWorksheet()

ブックの、現在作業中のワークシートを取得します。

getActiveWorksheet(): Worksheet;

戻り値

ExcelScript.Worksheet

getApplication()

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

getApplication(): Application;

戻り値

ExcelScript.Application

getAutoSave()

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

getAutoSave(): boolean;

戻り値

boolean

getBinding(id)

ID を使用してバインド オブジェクトを取得します。 バインド オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getBinding(id: string): Binding | undefined;

パラメーター

id

string

取得するバインド オブジェクトの ID。

戻り値

ExcelScript.Binding | undefined

getBindings()

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

getBindings(): Binding[];

戻り値

ExcelScript.Binding[]

getCalculationEngineVersion()

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

getCalculationEngineVersion(): number;

戻り値

number

getChartDataPointTrack()

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

getChartDataPointTrack(): boolean;

戻り値

boolean

getComment(commentId)

ID に基づいてコレクションからコメントを取得します。 コメント オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getComment(commentId: string): Comment | undefined;

パラメーター

commentId

string

コメントの識別子。

戻り値

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。

getCommentByCell(cellAddress: Range | string): Comment;

パラメーター

cellAddress

ExcelScript.Range | string

コメントがオンになっているセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

戻り値

ExcelScript.Comment

getCommentByReplyId(replyId)

指定された応答が接続されているコメントを取得します。

getCommentByReplyId(replyId: string): Comment;

パラメーター

replyId

string

コメント応答の識別子。

戻り値

ExcelScript.Comment

getComments()

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

getComments(): Comment[];

戻り値

ExcelScript.Comment[]

getCustomXmlPart(id)

ID に基づいて、カスタム XML パーツを取得します。 CustomXmlPartが存在しない場合、このメソッドはundefinedを返します。

getCustomXmlPart(id: string): CustomXmlPart | undefined;

パラメーター

id

string

取得するオブジェクトの ID。

戻り値

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

警告

この API は非推奨になりました。

Use getCustomXmlPartsByNamespace instead.

名前空間が指定された名前空間と一致するカスタム XML パーツの新しいコレクションを取得します。

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

パラメーター

namespaceUri

string

これは完全修飾スキーマ URI である必要があります。たとえば、"http://schemas.contoso.com/review/1.0"。

戻り値

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

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

getCustomXmlParts(): CustomXmlPart[];

戻り値

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

名前空間が指定された名前空間と一致するカスタム XML パーツの新しいコレクションを取得します。

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

パラメーター

namespaceUri

string

これは完全修飾スキーマ URI である必要があります。たとえば、"http://schemas.contoso.com/review/1.0"。

戻り値

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。

getDefaultPivotTableStyle(): PivotTableStyle;

戻り値

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

親オブジェクトのスコープの既定の SlicerStyle を取得します。

getDefaultSlicerStyle(): SlicerStyle;

戻り値

ExcelScript.SlicerStyle

getDefaultTableStyle()

親オブジェクトのスコープの既定のテーブル スタイルを取得します。

getDefaultTableStyle(): TableStyle;

戻り値

ExcelScript.TableStyle

getDefaultTimelineStyle()

親オブジェクトのスコープの既定のタイムライン スタイルを取得します。

getDefaultTimelineStyle(): TimelineStyle;

戻り値

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

コレクション内の最初のワークシートを取得します。

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

パラメーター

visibleOnly

boolean

省略可能。 true 場合は、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。

戻り値

ExcelScript.Worksheet

getIsDirty()

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

getIsDirty(): boolean;

戻り値

boolean

getLastWorksheet(visibleOnly)

コレクション内の最後のワークシートを取得します。

getLastWorksheet(visibleOnly?: boolean): Worksheet;

パラメーター

visibleOnly

boolean

省略可能。 true 場合は、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。

戻り値

ExcelScript.Worksheet

getLinkedWorkbookByUrl(key)

リンクされたブックに関する情報を URL で取得します。 ブックが存在しない場合、このメソッドは undefinedを返します。

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

パラメーター

key

string

リンクされたブックの URL。

戻り値

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

ブック リンクの更新モードを表します。 このモードは、ブックに存在するすべてのブック リンクで同じです。

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

戻り値

ExcelScript.WorkbookLinksRefreshMode

例

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }

getLinkedWorkbooks()

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

getLinkedWorkbooks(): LinkedWorkbook[];

戻り値

ExcelScript.LinkedWorkbook[]

例

/**
 * This script removes all links to other workbooks.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get all the linked workbook references.
    const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
    console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);

    // Remove all the links to those workbooks.
    // This changes the value of cells with workbook links to "#CONNECT!".
    externalWorkbooks.forEach((workbookLink) => {
        workbookLink.breakLinks();
    });
}

getName()

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

getName(): string;

戻り値

string

例

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

getNamedItem(name)

名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getNamedItem(name: string): NamedItem | undefined;

パラメーター

name

string

名前付き項目名。

戻り値

ExcelScript.NamedItem | undefined

getNames()

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

getNames(): NamedItem[];

戻り値

ExcelScript.NamedItem[]

例

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getPivotTable(name)

名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは undefinedを返します。

getPivotTable(name: string): PivotTable | undefined;

パラメーター

name

string

取得するピボットテーブルの名前。

戻り値

ExcelScript.PivotTable | undefined

getPivotTables()

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

getPivotTables(): PivotTable[];

戻り値

ExcelScript.PivotTable[]

getPivotTableStyle(name)

名前で PivotTableStyle を取得します。 PivotTableStyleが存在しない場合、このメソッドはundefinedを返します。

getPivotTableStyle(name: string): PivotTableStyle | undefined;

パラメーター

name

string

取得するピボットテーブル スタイルの名前。

戻り値

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

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

getPivotTableStyles(): PivotTableStyle[];

戻り値

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

名前に基づいてスタイルを取得します。 style オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

パラメーター

name

string

取得するスタイルの名前。

戻り値

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

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

getPredefinedCellStyles(): PredefinedCellStyle[];

戻り値

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

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

getPreviouslySaved(): boolean;

戻り値

boolean

getProperties()

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

getProperties(): DocumentProperties;

戻り値

ExcelScript.DocumentProperties

getProtection()

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

getProtection(): WorkbookProtection;

戻り値

ExcelScript.WorkbookProtection

例

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

getQueries()

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

getQueries(): Query[];

戻り値

ExcelScript.Query[]

getQuery(key)

コレクションの名前に基づいてクエリを取得します。

getQuery(key: string): Query;

パラメーター

key

string

大文字と小文字を区別しないクエリの名前。

戻り値

ExcelScript.Query

getReadOnly()

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

getReadOnly(): boolean;

戻り値

boolean

getSelectedRange()

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

getSelectedRange(): Range;

戻り値

ExcelScript.Range

getSelectedRanges()

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

getSelectedRanges(): RangeAreas;

戻り値

ExcelScript.RangeAreas

getSlicer(key)

名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは undefinedを返します。

getSlicer(key: string): Slicer | undefined;

パラメーター

key

string

取得するスライサーの名前または ID。

戻り値

ExcelScript.Slicer | undefined

getSlicers()

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

getSlicers(): Slicer[];

戻り値

ExcelScript.Slicer[]

getSlicerStyle(name)

名前で SlicerStyle を取得します。 スライサー スタイルが存在しない場合、このメソッドは undefinedを返します。

getSlicerStyle(name: string): SlicerStyle | undefined;

パラメーター

name

string

取得するスライサー スタイルの名前。

戻り値

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

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

getSlicerStyles(): SlicerStyle[];

戻り値

ExcelScript.SlicerStyle[]

getTable(key)

名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは undefinedを返します。

getTable(key: string): Table | undefined;

パラメーター

key

string

取得するテーブルの名前または ID。

戻り値

ExcelScript.Table | undefined

getTables()

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

getTables(): Table[];

戻り値

ExcelScript.Table[]

getTableStyle(name)

名前で TableStyle を取得します。 テーブル スタイルが存在しない場合、このメソッドは undefinedを返します。

getTableStyle(name: string): TableStyle | undefined;

パラメーター

name

string

取得するテーブル スタイルの名前。

戻り値

ExcelScript.TableStyle | undefined

getTableStyles()

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

getTableStyles(): TableStyle[];

戻り値

ExcelScript.TableStyle[]

getTimelineStyle(name)

名前で TimelineStyle を取得します。 タイムラインスタイルが存在しない場合、このメソッドは undefinedを返します。

getTimelineStyle(name: string): TimelineStyle | undefined;

パラメーター

name

string

取得するタイムライン スタイルの名前。

戻り値

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

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

getTimelineStyles(): TimelineStyle[];

戻り値

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

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

getUsePrecisionAsDisplayed(): boolean;

戻り値

boolean

getWorksheet(key)

名前または ID を使用して、ワークシート オブジェクトを取得します。 ワークシートが存在しない場合、このメソッドは undefinedを返します。

getWorksheet(key: string): Worksheet | undefined;

パラメーター

key

string

ワークシートの名前または ID。

戻り値

ExcelScript.Worksheet | undefined

例

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

getWorksheets()

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

getWorksheets(): Worksheet[];

戻り値

ExcelScript.Worksheet[]

例

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

すべてのデータ接続を更新します。

refreshAllDataConnections(): void;

戻り値

void

refreshAllLinksToLinkedWorkbooks()

すべてのブック リンクを更新するように要求します。

refreshAllLinksToLinkedWorkbooks(): void;

戻り値

void

refreshAllPivotTables()

コレクション内のすべてのピボットテーブルを更新します。

refreshAllPivotTables(): void;

戻り値

void

setChartDataPointTrack(chartDataPointTrack)

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

setChartDataPointTrack(chartDataPointTrack: boolean): void;

パラメーター

chartDataPointTrack

boolean

戻り値

void

setDefaultPivotTableStyle(newDefaultStyle)

親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

パラメーター

newDefaultStyle

ExcelScript.PivotTableStyle | string

PivotTableStyle オブジェクト(PivotTableStyle オブジェクトの名前)は、新しい既定値にする必要があります。

戻り値

void

setDefaultSlicerStyle(newDefaultStyle)

親オブジェクトのスコープで使用する既定のスライサー スタイルを設定します。

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

パラメーター

newDefaultStyle

ExcelScript.SlicerStyle | string

SlicerStyle オブジェクト(SlicerStyle オブジェクトの名前)は、新しい既定値にする必要があります。

戻り値

void

setDefaultTableStyle(newDefaultStyle)

親オブジェクトのスコープで使用する既定のテーブル スタイルを設定します。

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

パラメーター

newDefaultStyle

ExcelScript.TableStyle | string

TableStyle オブジェクト(TableStyle オブジェクトの名前)は、新しい既定値にする必要があります。

戻り値

void

setDefaultTimelineStyle(newDefaultStyle)

親オブジェクトのスコープで使用する既定のタイムライン スタイルを設定します。

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

パラメーター

newDefaultStyle

ExcelScript.TimelineStyle | string

TimelineStyle オブジェクト(TimelineStyle オブジェクトの名前)は、新しい既定値にする必要があります。

戻り値

void

setIsDirty(isDirty)

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

setIsDirty(isDirty: boolean): void;

パラメーター

isDirty

boolean

戻り値

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

ブック リンクの更新モードを表します。 このモードは、ブックに存在するすべてのブック リンクで同じです。

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

パラメーター

linkedWorkbookRefreshMode

ExcelScript.WorkbookLinksRefreshMode

戻り値

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

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

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

パラメーター

usePrecisionAsDisplayed

boolean

戻り値

void