Excel.Worksheet class

Excel のワークシートは、セルのグリッドです。An Excel worksheet is a grid of cells. データ、表、グラフなどを含めることができます。It can contain data, tables, charts, etc.

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

Extends

プロパティ

autoFilter

ワークシートの AutoFilter オブジェクトを表します。Represents the AutoFilter object of the worksheet. 読み取り専用です。Read-Only.

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

charts

ワークシートの一部になっているグラフのコレクションを返します。Returns collection of charts that are part of the worksheet. 値の取得のみ可能です。Read-only.

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

comments

ワークシート上のすべての Comments オブジェクトの集まりを返します。Returns a collection of all the Comments objects on the worksheet. 読み取り専用です。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.

enableCalculation

ワークシートの enableCalculation プロパティを取得または設定します。Gets or sets the enableCalculation property of the worksheet. True の場合、Excel は必要に応じてワークシートを再計算します。True if Excel recalculates the worksheet when necessary. False の場合、Excel はシートを再計算しません。False if Excel doesn't recalculate the sheet.

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

freezePanes

ワークシート上の固定されたウィンドウを操作するために使用できるオブジェクトを取得します。Gets an object that can be used to manipulate frozen panes on the worksheet. 読み取り専用です。Read-only.

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

horizontalPageBreaks

ワークシートの水平改ページをまとめて取得します。Gets the horizontal page break collection for the worksheet. このコレクションには、手動の改ページのみが含まれます。This collection only contains manual page breaks.

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

id

指定されたブックのワークシートを一意に識別する値を返します。この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。値の取得のみ可能です。Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.

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

name

ワークシートの表示名。The display name of the worksheet.

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

names

現在のワークシートにスコープされている名前のコレクション。Collection of names scoped to the current worksheet. 読み取り専用です。Read-only.

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

pageLayout

ワークシートの PageLayout オブジェクトを取得します。Gets the PageLayout object of the worksheet.

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

pivotTables

ワークシートの一部になっているピボットテーブルのコレクション。Collection of PivotTables that are part of the worksheet. 読み取り専用です。Read-only.

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

position

0 を起点とした、ブック内のワークシートの位置。The zero-based position of the worksheet within the workbook.

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

protection

ワークシートのシート保護オブジェクトを返します。Returns sheet protection object for a worksheet. 読み取り専用。Read-only.

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

shapes

ワークシート上のすべての Shape オブジェクトをまとめて返します。Returns the collection of all the Shape objects on the worksheet. 読み取り専用です。Read-only.

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

showGridlines

ワークシートの gridlines フラグを取得または設定します。Gets or sets the worksheet's gridlines flag. このフラグは、グリッド線をユーザーに表示するかどうかを指定します。This flag determines whether gridlines are visible to the user.

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

showHeadings

ワークシートの headings フラグを取得または設定します。Gets or sets the worksheet's headings flag. このフラグは、ユーザーに見出しを表示するかどうかを指定します。This flag determines whether headings are visible to the user.

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

slicers

ワークシートに含まれるスライサーをまとめて返します。Returns collection of slicers that are part of the worksheet. 読み取り専用です。Read-only.

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

standardHeight

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。Returns the standard (default) height of all the rows in the worksheet, in points. 読み取り専用です。Read-only.

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

standardWidth

ワークシートのすべての列の標準 (既定) の幅を返すか設定します。Returns or sets the standard (default) width of all the columns in the worksheet. 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。One unit of column width is equal to the width of one character in the Normal style. プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。For proportional fonts, the width of the character 0 (zero) is used.

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

tabColor

ワークシートのタブの色を取得または設定します。Gets or sets the worksheet tab color. タブの色を取得するときに、ワークシートが非表示の場合、値は null になります。When retrieving the tab color, if the worksheet is invisible, the value will be null. ワークシートが表示されているにもかかわらず、tab の色が auto に設定されている場合は、空の文字列が返されます。If the worksheet is visible but the tab color is set to auto, an empty string will be returned. それ以外の場合は、プロパティは "#123456" という色を設定するときに、"" という形式で設定されます。色を設定するときは、空の文字列を使用して "auto" 色を設定するか、または実際の色を設定します。Otherwise, the property will be set to a color, in the form "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

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

tables

ワークシートの一部になっているグラフのコレクション。Collection of tables that are part of the worksheet. 値の取得のみ可能です。Read-only.

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

verticalPageBreaks

ワークシートの垂直改ページをまとめて取得します。Gets the vertical page break collection for the worksheet. このコレクションには、手動の改ページのみが含まれます。This collection only contains manual page breaks.

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

visibility

ワークシートの可視性。The Visibility of the worksheet.

[API set: 表示を読み取るための excelapi 1.1、設定用の 1.2[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]

メソッド

activate()

Excel UI でワークシートをアクティブにします。Activate the worksheet in the Excel UI.

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

calculate(markAllDirty)

ワークシート上のすべてのセルを計算します。Calculates all cells on a worksheet.

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

copy(positionType, relativeTo)

ワークシートをコピーして、指定した位置に配置します。Copy a worksheet and place it at the specified position. コピーしたワークシートを返します。Return the copied worksheet.

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

copy(positionTypeString, relativeTo)

ワークシートをコピーして、指定した位置に配置します。Copy a worksheet and place it at the specified position. コピーしたワークシートを返します。Return the copied worksheet.

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

delete()

ブックからワークシートを削除します。Deletes the worksheet from the workbook.

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

findAll(text, criteria)

指定された条件に基づいて指定された文字列の発生箇所をすべて見つけ、1 つまたは複数の長方形範囲を構成する RangeAreas オブジェクトとして返します。Finds all occurrences of the given string based on the criteria specified and returns them as a RangeAreas object, comprising one or more rectangular ranges.

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

findAllOrNullObject(text, criteria)

指定された条件に基づいて指定された文字列の発生箇所をすべて見つけ、1 つまたは複数の長方形範囲を構成する RangeAreas オブジェクトとして返します。Finds all occurrences of the given string based on the criteria specified and returns them as a RangeAreas object, comprising one or more rectangular ranges.

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

getCell(row, column)

行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。Gets the range object containing the single cell based on row and column numbers. ワークシートのグリッド内に収まるセルは、親の範囲の境界の外側にある場合があります。The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid.

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

getNext(visibleOnly)

これに続くワークシートを取得します。Gets the worksheet that follows this one. このメソッドに続くワークシートがない場合、このメソッドはエラーをスローします。If there are no worksheets following this one, this method will throw an error.

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

getNextOrNullObject(visibleOnly)

これに続くワークシートを取得します。Gets the worksheet that follows this one. このメソッドに続くワークシートがない場合、このメソッドは null オブジェクトを返します。If there are no worksheets following this one, this method will return a null object.

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

getPrevious(visibleOnly)

これより前のワークシートを取得します。Gets the worksheet that precedes this one. 前のワークシートがない場合、このメソッドはエラーをスローします。If there are no previous worksheets, this method will throw an error.

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

getPreviousOrNullObject(visibleOnly)

これより前のワークシートを取得します。Gets the worksheet that precedes this one. 前のワークシートがない場合、このメソッドは null の objet を返します。If there are no previous worksheets, this method will return a null objet.

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

getRange(address)

アドレスまたは名前で指定された、セルの単一の四角形のブロックを表す range オブジェクトを取得します。Gets the range object, representing a single rectangular block of cells, specified by the address or name.

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

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

特定の行インデックスと列インデックスから開始し、一定数の行と列にわたる、Range オブジェクトを取得します。Gets the range object beginning at a particular row index and column index, and spanning a certain number of rows and columns.

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

getRanges(address)

アドレスまたは名前で指定され、1 つまたは複数の長方形範囲ブロックを表す RangeAreas オブジェクトを取得します。Gets the RangeAreas object, representing one or more blocks of rectangular ranges, specified by the address or name.

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

getUsedRange(valuesOnly)

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. ワークシート全体が空白の場合、この関数は左上のセルを返します (つまり、エラーはスローされません)。If the entire worksheet is blank, this function will return the top left cell (i.e. it will not throw an error).

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

getUsedRangeOrNullObject(valuesOnly)

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。ワークシート全体が空白の場合、この関数は null オブジェクトを返します。The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return a null object.

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

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.

replaceAll(text, replacement, criteria)

現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。Finds and replaces the given string based on the criteria specified within the current worksheet.

[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オブジェクトのメソッドを呼び出します。元の Worksheet オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorksheetData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Worksheet object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

イベント

onActivated

ワークシートがアクティブになるときに発生します。Occurs when the worksheet is activated.

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

onCalculated

ワークシートが計算されるときに発生します。Occurs when the worksheet is calculated.

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

onChanged

特定のワークシートでデータが変更されたときに発生します。Occurs when data changed on a specific worksheet.

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

onDeactivated

ワークシートが非アクティブになるときに発生します。Occurs when the worksheet is deactivated.

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

onFiltered

フィルターが特定のワークシートに適用されたときに発生します。Occurs when filter is applied on a specific worksheet.

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

onFormatChanged

フォーマットが特定のワークシートで変更されたときに発生します。Occurs when format changed on a specific worksheet.

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

onSelectionChanged

特定のワークシートで選択範囲が変更されたときに発生します。Occurs when the selection changes on a specific worksheet.

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

プロパティの詳細

autoFilter

注意

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

ワークシートの AutoFilter オブジェクトを表します。Represents the AutoFilter object of the worksheet. 読み取り専用です。Read-Only.

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

readonly autoFilter: Excel.AutoFilter;

プロパティ値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // This filter will only show the rows with the top 25% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, { criterion1: "25", filterOn: Excel.FilterOn.topPercent });
    await context.sync();
});

charts

ワークシートの一部になっているグラフのコレクションを返します。Returns collection of charts that are part of the worksheet. 値の取得のみ可能です。Read-only.

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

readonly charts: Excel.ChartCollection;

プロパティ値

comments

注意

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

ワークシート上のすべての Comments オブジェクトの集まりを返します。Returns a collection of all the Comments objects on the worksheet. 読み取り専用です。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

enableCalculation

注意

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

ワークシートの enableCalculation プロパティを取得または設定します。Gets or sets the enableCalculation property of the worksheet. True の場合、Excel は必要に応じてワークシートを再計算します。True if Excel recalculates the worksheet when necessary. False の場合、Excel はシートを再計算しません。False if Excel doesn't recalculate the sheet.

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

enableCalculation: boolean;

プロパティ値

boolean

freezePanes

ワークシート上の固定されたウィンドウを操作するために使用できるオブジェクトを取得します。Gets an object that can be used to manipulate frozen panes on the worksheet. 読み取り専用です。Read-only.

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

readonly freezePanes: Excel.WorksheetFreezePanes;

プロパティ値

horizontalPageBreaks

注意

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

ワークシートの水平改ページをまとめて取得します。Gets the horizontal page break collection for the worksheet. このコレクションには、手動の改ページのみが含まれます。This collection only contains manual page breaks.

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

readonly horizontalPageBreaks: Excel.PageBreakCollection;

プロパティ値

id

指定されたブックのワークシートを一意に識別する値を返します。この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。値の取得のみ可能です。Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.

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

readonly id: string;

プロパティ値

string

name

ワークシートの表示名。The display name of the worksheet.

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

name: string;

プロパティ値

string

names

現在のワークシートにスコープされている名前のコレクション。Collection of names scoped to the current worksheet. 読み取り専用です。Read-only.

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

readonly names: Excel.NamedItemCollection;

プロパティ値

pageLayout

注意

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

ワークシートの PageLayout オブジェクトを取得します。Gets the PageLayout object of the worksheet.

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

readonly pageLayout: Excel.PageLayout;

プロパティ値

pivotTables

ワークシートの一部になっているピボットテーブルのコレクション。Collection of PivotTables that are part of the worksheet. 読み取り専用です。Read-only.

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

readonly pivotTables: Excel.PivotTableCollection;

プロパティ値

position

0 を起点とした、ブック内のワークシートの位置。The zero-based position of the worksheet within the workbook.

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

position: number;

プロパティ値

number

protection

ワークシートのシート保護オブジェクトを返します。Returns sheet protection object for a worksheet. 読み取り専用。Read-only.

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

readonly protection: Excel.WorksheetProtection;

プロパティ値

shapes

注意

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

ワークシート上のすべての Shape オブジェクトをまとめて返します。Returns the collection of all the Shape objects on the worksheet. 読み取り専用です。Read-only.

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

readonly shapes: Excel.ShapeCollection;

プロパティ値

showGridlines

ワークシートの gridlines フラグを取得または設定します。Gets or sets the worksheet's gridlines flag. このフラグは、グリッド線をユーザーに表示するかどうかを指定します。This flag determines whether gridlines are visible to the user.

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

showGridlines: boolean;

プロパティ値

boolean

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.showGridlines = true;

    await context.sync();
});

showHeadings

ワークシートの headings フラグを取得または設定します。Gets or sets the worksheet's headings flag. このフラグは、ユーザーに見出しを表示するかどうかを指定します。This flag determines whether headings are visible to the user.

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

showHeadings: boolean;

プロパティ値

boolean

slicers

注意

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

ワークシートに含まれるスライサーをまとめて返します。Returns collection of slicers that are part of the worksheet. 読み取り専用です。Read-only.

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

readonly slicers: Excel.SlicerCollection;

プロパティ値

standardHeight

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。Returns the standard (default) height of all the rows in the worksheet, in points. 読み取り専用です。Read-only.

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

readonly standardHeight: number;

プロパティ値

number

standardWidth

ワークシートのすべての列の標準 (既定) の幅を返すか設定します。Returns or sets the standard (default) width of all the columns in the worksheet. 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。One unit of column width is equal to the width of one character in the Normal style. プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。For proportional fonts, the width of the character 0 (zero) is used.

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

standardWidth: number;

プロパティ値

number

tabColor

ワークシートのタブの色を取得または設定します。Gets or sets the worksheet tab color. タブの色を取得するときに、ワークシートが非表示の場合、値は null になります。When retrieving the tab color, if the worksheet is invisible, the value will be null. ワークシートが表示されているにもかかわらず、tab の色が auto に設定されている場合は、空の文字列が返されます。If the worksheet is visible but the tab color is set to auto, an empty string will be returned. それ以外の場合は、プロパティは "#123456" という色を設定するときに、"" という形式で設定されます。色を設定するときは、空の文字列を使用して "auto" 色を設定するか、または実際の色を設定します。Otherwise, the property will be set to a color, in the form "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

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

tabColor: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tables

ワークシートの一部になっているグラフのコレクション。Collection of tables that are part of the worksheet. 値の取得のみ可能です。Read-only.

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

readonly tables: Excel.TableCollection;

プロパティ値

verticalPageBreaks

注意

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

ワークシートの垂直改ページをまとめて取得します。Gets the vertical page break collection for the worksheet. このコレクションには、手動の改ページのみが含まれます。This collection only contains manual page breaks.

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

readonly verticalPageBreaks: Excel.PageBreakCollection;

プロパティ値

visibility

ワークシートの可視性。The Visibility of the worksheet.

[API set: 表示を読み取るための excelapi 1.1、設定用の 1.2[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

プロパティ値

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

メソッドの詳細

activate()

Excel UI でワークシートをアクティブにします。Activate the worksheet in the Excel UI.

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

activate(): void;

戻り値

void

Examples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

calculate(markAllDirty)

ワークシート上のすべてのセルを計算します。Calculates all cells on a worksheet.

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

calculate(markAllDirty: boolean): void;

パラメーター

markAllDirty
boolean

True を設定すると、すべてがダーティとしてマークされます。True, to mark all as dirty.

戻り値

void

copy(positionType, relativeTo)

ワークシートをコピーして、指定した位置に配置します。Copy a worksheet and place it at the specified position. コピーしたワークシートを返します。Return the copied worksheet.

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

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

パラメーター

positionType
Excel.WorksheetPositionType

省略可能。Optional.

relativeTo
Excel.Worksheet

省略可能。Optional.

戻り値

Examples

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

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

copy(positionTypeString, relativeTo)

ワークシートをコピーして、指定した位置に配置します。Copy a worksheet and place it at the specified position. コピーしたワークシートを返します。Return the copied worksheet.

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

copy(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

パラメーター

positionTypeString
"None" | "Before" | "After" | "Beginning" | "End"

省略可能。Optional.

relativeTo
Excel.Worksheet

省略可能。Optional.

戻り値

delete()

ブックからワークシートを削除します。Deletes the worksheet from the workbook.

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

delete(): void;

戻り値

void

Examples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

findAll(text, criteria)

注意

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

指定された条件に基づいて指定された文字列の発生箇所をすべて見つけ、1 つまたは複数の長方形範囲を構成する RangeAreas オブジェクトとして返します。Finds all occurrences of the given string based on the criteria specified and returns them as a RangeAreas object, comprising one or more rectangular ranges.

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

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

パラメーター

text
string

検索する文字列を指定します。String to find.

criteria
Excel.WorksheetSearchCriteria

追加の条件。Additional Criteria.

戻り値

検索条件に一致する1つまたは複数の四角形の範囲で構成される rangearea オブジェクト。A RangeArea object, comprising one or more rectangular ranges, that matches the search criteria. この条件に一致するセルがない場合は、ItemNotFound エラーがスローされます。If no cells meet this criteria, an ItemNotFound error will be thrown.

findAllOrNullObject(text, criteria)

注意

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

指定された条件に基づいて指定された文字列の発生箇所をすべて見つけ、1 つまたは複数の長方形範囲を構成する RangeAreas オブジェクトとして返します。Finds all occurrences of the given string based on the criteria specified and returns them as a RangeAreas object, comprising one or more rectangular ranges.

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

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

パラメーター

text
string

検索する文字列を指定します。String to find.

criteria
Excel.WorksheetSearchCriteria

追加の条件。Additional Criteria.

戻り値

検索条件に一致する1つまたは複数の四角形の範囲で構成される rangearea オブジェクト。A RangeArea object, comprising one or more rectangular ranges, that matches the search criteria. 一致しない場合、この関数は null オブジェクトを返します。If there are no matches, this function will return a null object.

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

getCell(row, column)

行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。Gets the range object containing the single cell based on row and column numbers. ワークシートのグリッド内に収まるセルは、親の範囲の境界の外側にある場合があります。The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid.

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

getCell(row: number, column: number): Excel.Range;

パラメーター

row
number

取得するセルの行番号。The row number of the cell to be retrieved. 0 を起点とする番号になります。Zero-indexed.

column
number

取得するセルの列番号。the column number of the cell to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var cell = worksheet.getCell(0,0);
    cell.load('address');
    return ctx.sync().then(function() {
        console.log(cell.address);
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getNext(visibleOnly)

これに続くワークシートを取得します。Gets the worksheet that follows this one. このメソッドに続くワークシートがない場合、このメソッドはエラーをスローします。If there are no worksheets following this one, this method will throw an error.

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

getNext(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

visibleOnly
boolean

省略可能です。Optional. true の場合は、表示されているワークシートのみを考慮し、非表示のワークシートについてはスキップします。If true, considers only visible worksheets, skipping over any hidden ones.

戻り値

Examples

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

これに続くワークシートを取得します。Gets the worksheet that follows this one. このメソッドに続くワークシートがない場合、このメソッドは null オブジェクトを返します。If there are no worksheets following this one, this method will return a null object.

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

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

visibleOnly
boolean

省略可能です。Optional. true の場合は、表示されているワークシートのみを考慮し、非表示のワークシートについてはスキップします。If true, considers only visible worksheets, skipping over any hidden ones.

戻り値

getPrevious(visibleOnly)

これより前のワークシートを取得します。Gets the worksheet that precedes this one. 前のワークシートがない場合、このメソッドはエラーをスローします。If there are no previous worksheets, this method will throw an error.

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

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

visibleOnly
boolean

省略可能です。Optional. true の場合は、表示されているワークシートのみを考慮し、非表示のワークシートについてはスキップします。If true, considers only visible worksheets, skipping over any hidden ones.

戻り値

Examples

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

これより前のワークシートを取得します。Gets the worksheet that precedes this one. 前のワークシートがない場合、このメソッドは null の objet を返します。If there are no previous worksheets, this method will return a null objet.

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

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

visibleOnly
boolean

省略可能です。Optional. true の場合は、表示されているワークシートのみを考慮し、非表示のワークシートについてはスキップします。If true, considers only visible worksheets, skipping over any hidden ones.

戻り値

getRange(address)

アドレスまたは名前で指定された、セルの単一の四角形のブロックを表す range オブジェクトを取得します。Gets the range object, representing a single rectangular block of cells, specified by the address or name.

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

getRange(address?: string): Excel.Range;

パラメーター

address
string

省略可能です。Optional. 範囲のアドレスまたは名前を表す文字列。The string representing the address or name of the range. たとえば、"A1: B2" となります。For example, "A1:B2". 指定されていない場合は、ワークシート全体の範囲が返されます。If not specified, the entire worksheet range is returned.

戻り値

Examples

// Below example uses range address to get the range object.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Below example uses a named-range to get the range object.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeName = 'MyRange';
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeName);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

特定の行インデックスと列インデックスから開始し、一定数の行と列にわたる、Range オブジェクトを取得します。Gets the range object beginning at a particular row index and column index, and spanning a certain number of rows and columns.

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

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

パラメーター

startRow
number

開始行 (ゼロインデックス)。Start row (zero-indexed).

startColumn
number

開始列 (ゼロインデックス)。Start column (zero-indexed).

rowCount
number

範囲に含める行の数を指定します。Number of rows to include in the range.

columnCount
number

範囲に含める列の数を指定します。Number of columns to include in the range.

戻り値

getRanges(address)

注意

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

アドレスまたは名前で指定され、1 つまたは複数の長方形範囲ブロックを表す RangeAreas オブジェクトを取得します。Gets the RangeAreas object, representing one or more blocks of rectangular ranges, specified by the address or name.

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

getRanges(address?: string): Excel.RangeAreas;

パラメーター

address
string

省略可能です。Optional. コンマ区切りのアドレスまたは個々の範囲の名前を含む文字列。A string containing the comma-separated addresses or names of the individual ranges. たとえば、"A1: B2, A5: B5" とします。For example, "A1:B2, A5:B5". 指定しない場合、ワークシート全体の rangearea オブジェクトが返されます。If not specified, an RangeArea object for the entire worksheet is returned.

戻り値

Examples

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

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

getUsedRange(valuesOnly)

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. ワークシート全体が空白の場合、この関数は左上のセルを返します (つまり、エラーはスローされません)。If the entire worksheet is blank, this function will return the top left cell (i.e. it will not throw an error).

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

getUsedRange(valuesOnly?: boolean): Excel.Range;

パラメーター

valuesOnly
boolean

省略可能です。Optional. true の場合は、値を持つセルのみを使用セルと見なします (書式設定は無視されます)。If true, considers only cells with values as used cells (ignoring formatting). [Api セット: excelapi 1.2][Api set: ExcelApi 1.2]

戻り値

Examples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    var usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    return ctx.sync().then(function() {
            console.log(usedRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getUsedRangeOrNullObject(valuesOnly)

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。ワークシート全体が空白の場合、この関数は null オブジェクトを返します。The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return a null object.

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

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

パラメーター

valuesOnly
boolean

省略可能。Optional. 値の入っているセルのみを使用セルと見なします。Considers only cells with values as used cells.

戻り値

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.WorksheetLoadOptions): Excel.Worksheet;

パラメーター

戻り値

注釈

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

load(option?: string | string[]): Excel.Worksheet-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Worksheet - 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.Worksheet-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Worksheet - 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.Worksheet-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Worksheet - 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.Worksheet;

パラメーター

propertyNames
string | string[]

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

戻り値

Examples

// Get worksheet properties based on sheet name.
Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    return ctx.sync().then(function() {
            console.log(worksheet.position);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Set worksheet position. 
Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

パラメーター

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.

戻り値

replaceAll(text, replacement, criteria)

注意

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

現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。Finds and replaces the given string based on the criteria specified within the current worksheet.

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

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

パラメーター

text
string

検索する文字列を指定します。String to find.

replacement
string

元のと置き換える文字列。String to replace the original with.

criteria
Excel.ReplaceCriteria

置換条件を追加します。Additional Replace Criteria.

戻り値

OfficeExtension.ClientResult<number>

実行された置換の数。The number of replacements performed.

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.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.WorksheetUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 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.Worksheet): void

set(properties)

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

set(properties: Excel.Worksheet): void;

パラメーター

properties
Excel.Worksheet

戻り値

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オブジェクトのメソッドを呼び出します。元の Worksheet オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorksheetData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Worksheet object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WorksheetData;

戻り値

イベントの詳細

onActivated

ワークシートがアクティブになるときに発生します。Occurs when the worksheet is activated.

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

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Examples

Excel.run(function (context) {
    var sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run((context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            return context.sync();
        });
    });
    return context.sync();
});

onCalculated

ワークシートが計算されるときに発生します。Occurs when the worksheet is calculated.

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

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Examples

Excel.run(function (context) {
    var sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run((context) => {
            console.log("The worksheet has recalculated.");
            return context.sync();
        });
    });
    return context.sync();
});

onChanged

特定のワークシートでデータが変更されたときに発生します。Occurs when data changed on a specific worksheet.

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

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the onChanged event.");
});

onDeactivated

ワークシートが非アクティブになるときに発生します。Occurs when the worksheet is deactivated.

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

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Examples

Excel.run(function (context) {
    var sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run((context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            return context.sync();
        });
    });
    return context.sync();
});

onFiltered

注意

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

フィルターが特定のワークシートに適用されたときに発生します。Occurs when filter is applied on a specific worksheet.

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

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

onFormatChanged

注意

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

フォーマットが特定のワークシートで変更されたときに発生します。Occurs when format changed on a specific worksheet.

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

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

onSelectionChanged

特定のワークシートで選択範囲が変更されたときに発生します。Occurs when the selection changes on a specific worksheet.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Examples

Excel.run(function (context) {
    var sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run((context) => {
            console.log("The selected range has changed to: " + event.address);
            return context.sync();
        });
    });
    return context.sync();
});