Excel.Worksheet class
Excel のワークシートは、セルのグリッドです。 データ、テーブル、グラフなどを含めることができます。ワークシート オブジェクト モデルの詳細については、「 Excel JavaScript API を使用してワークシートを操作する」を参照してください。
- Extends
注釈
プロパティ
| charts | ワークシートの一部であるグラフのコレクションを返します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| freeze |
ワークシート上の固定ウィンドウを操作するために使用できるオブジェクトを取得します。 |
| id | 指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。 |
| name | ワークシートの表示名。 |
| names | 現在のワークシートにスコープされている名前のコレクション。 |
| pivot |
ワークシートの一部になっているピボットテーブルのコレクション。 |
| position | 0 を起点とした、ブック内のワークシートの位置。 |
| protection | ワークシートのシート保護オブジェクトを返します。 |
| standard |
ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。 |
| standard |
ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。 |
| tab |
ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は になります |
| tables | ワークシートの一部になっているグラフのコレクション。 |
| visibility | ワークシートの可視性。 |
メソッド
| activate() | Excel UI でワークシートをアクティブにします。 |
| calculate(mark |
ワークシート上のすべてのセルを計算します。 |
| copy(position |
ワークシートをコピーし、指定した位置に配置します。 |
| copy(position |
ワークシートをコピーし、指定した位置に配置します。 |
| delete() | ブックからワークシートを削除します。 ワークシートの可視性が "VeryHidden" に設定されている場合、削除操作は例外で |
| get |
|
| get |
このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドはエラーをスローします。 |
| get |
このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドは プロパティが に設定されたオブジェクトを |
| get |
このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドはエラーをスローします。 |
| get |
このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドは プロパティが に設定されたオブジェクトを |
| get |
|
| get |
特定の |
| get |
使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、この関数は左上のセルを返します (つまり、エラーはスロー されません )。 |
| get |
使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、このメソッドは プロパティが に設定されたオブジェクトを |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
イベント
| on |
ワークシートがアクティブになったときに発生します。 |
| on |
特定のワークシートでデータが変更されたときに発生します。 |
| on |
ワークシートが非アクティブ化されたときに発生します。 |
| on |
特定のワークシートで選択内容が変更されたときに発生します。 |
プロパティの詳細
charts
ワークシートの一部であるグラフのコレクションを返します。
readonly charts: Excel.ChartCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
freezePanes
ワークシート上の固定ウィンドウを操作するために使用できるオブジェクトを取得します。
readonly freezePanes: Excel.WorksheetFreezePanes;プロパティ値
注釈
id
指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。
readonly id: string;プロパティ値
string
注釈
name
names
現在のワークシートにスコープされている名前のコレクション。
readonly names: Excel.NamedItemCollection;プロパティ値
注釈
pivotTables
ワークシートの一部になっているピボットテーブルのコレクション。
readonly pivotTables: Excel.PivotTableCollection;プロパティ値
注釈
例
// 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 current worksheet.
const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the current worksheet:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
position
0 を起点とした、ブック内のワークシートの位置。
position: number;プロパティ値
number
注釈
例
// Set worksheet position.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.position = 2;
await context.sync();
});
protection
ワークシートのシート保護オブジェクトを返します。
readonly protection: Excel.WorksheetProtection;プロパティ値
注釈
例
// Unprotecting a worksheet with unprotect() will remove all
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
sheet.protection.protect({
allowInsertRows: false, // Protect row insertion
allowDeleteRows: true // Unprotect row deletion
});
});
standardHeight
ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。
readonly standardHeight: number;プロパティ値
number
注釈
standardWidth
ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。
standardWidth: number;プロパティ値
number
注釈
tabColor
ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は になります null。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは #RRGGBB 形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定するか、それ以外の場合は実際の色を設定します。
tabColor: string;プロパティ値
string
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.tabColor = "#FF0000";
await context.sync();
});
tables
ワークシートの一部になっているグラフのコレクション。
readonly tables: Excel.TableCollection;プロパティ値
注釈
visibility
ワークシートの可視性。
visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";プロパティ値
Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"
注釈
メソッドの詳細
activate()
Excel UI でワークシートをアクティブにします。
activate(): void;戻り値
void
注釈
例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
calculate(markAllDirty)
ワークシート上のすべてのセルを計算します。
calculate(markAllDirty: boolean): void;パラメーター
- markAllDirty
-
boolean
True を指定すると、すべてダーティとしてマークされます。
戻り値
void
注釈
copy(positionType, relativeTo)
ワークシートをコピーし、指定した位置に配置します。
copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;パラメーター
- positionType
- Excel.WorksheetPositionType
新しく作成されたワークシートを配置するブック内の場所。 既定値は "None" で、ワークシートの先頭にワークシートが挿入されます。
- relativeTo
- Excel.Worksheet
新しく作成されたワークシートの位置を決定する既存のワークシート。 これは、"Before" または "After" の場合 positionType にのみ必要です。
戻り値
新しく作成されたワークシート。
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml
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(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;パラメーター
- positionTypeString
-
"None" | "Before" | "After" | "Beginning" | "End"
新しく作成されたワークシートを配置するブック内の場所。 既定値は "None" で、ワークシートの先頭にワークシートが挿入されます。
- relativeTo
- Excel.Worksheet
新しく作成されたワークシートの位置を決定する既存のワークシート。 これは、"Before" または "After" の場合 positionType にのみ必要です。
戻り値
新しく作成されたワークシート。
注釈
delete()
ブックからワークシートを削除します。 ワークシートの可視性が "VeryHidden" に設定されている場合、削除操作は例外で InvalidOperation 失敗します。 削除する前に、最初にその可視性を非表示または表示に変更する必要があります。
delete(): void;戻り値
void
注釈
例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.delete();
await context.sync();
});
getCell(row, column)
Range行番号と列番号に基づいて、1 つのセルを含むオブジェクトを取得します。 セルは、ワークシートのグリッド内に留まる限り、親範囲の範囲外にすることができます。
getCell(row: number, column: number): Excel.Range;パラメーター
- row
-
number
取得するセルの行番号。 0 を起点とする番号になります。
- column
-
number
取得するセルの列番号。 0 を起点とする番号になります。
戻り値
注釈
例
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const cell = worksheet.getCell(0,0);
cell.load('address');
await context.sync();
console.log(cell.address);
});
getNext(visibleOnly)
このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドはエラーをスローします。
getNext(visibleOnly?: boolean): Excel.Worksheet;パラメーター
- visibleOnly
-
boolean
オプション。 の場合 trueは、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。
戻り値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml
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)
このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;パラメーター
- visibleOnly
-
boolean
オプション。 の場合 trueは、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。
戻り値
注釈
getPrevious(visibleOnly)
このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドはエラーをスローします。
getPrevious(visibleOnly?: boolean): Excel.Worksheet;パラメーター
- visibleOnly
-
boolean
オプション。 の場合 trueは、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。
戻り値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml
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)
このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;パラメーター
- visibleOnly
-
boolean
オプション。 の場合 trueは、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。
戻り値
注釈
getRange(address)
Rangeアドレスまたは名前で指定された単一の四角形のセル ブロックを表す オブジェクトを取得します。
getRange(address?: string): Excel.Range;パラメーター
- address
-
string
オプション。 範囲のアドレスまたは名前を表す文字列。 たとえば、"A1:B2" です。 指定されていない場合は、ワークシート全体の範囲が返されます。
戻り値
注釈
例
// Use the range address to get the range object.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)
特定の Range 行インデックスと列インデックスから始まり、特定の数の行と列にまたがるオブジェクトを取得します。
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;パラメーター
- startRow
-
number
開始行 (インデックスが 0)。
- startColumn
-
number
開始列 (インデックスが 0)。
- rowCount
-
number
範囲に含める行の数。
- columnCount
-
number
範囲に含める列の数。
戻り値
注釈
getUsedRange(valuesOnly)
使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、この関数は左上のセルを返します (つまり、エラーはスロー されません )。
getUsedRange(valuesOnly?: boolean): Excel.Range;パラメーター
- valuesOnly
-
boolean
オプション。 の場合 trueは、値を持つセルのみを使用セルと見なします (書式設定は無視されます)。 [Api set: ExcelApi 1.2]
戻り値
注釈
例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
const usedRange = worksheet.getUsedRange();
usedRange.load('address');
await context.sync();
console.log(usedRange.address);
});
getUsedRangeOrNullObject(valuesOnly)
使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;パラメーター
- valuesOnly
-
boolean
オプション。 値の入っているセルのみを使用セルと見なします。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Worksheet;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Get worksheet properties based on sheet name.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.load('position')
await context.sync();
console.log(worksheet.position);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Worksheet;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.WorksheetUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
例
// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.set({
tabColor: "yellow",
name: "MySheet"
});
await context.sync();
});
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Worksheet): void;パラメーター
- properties
- Excel.Worksheet
戻り値
void
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Worksheet オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.WorksheetData型指定) を返します。
toJSON(): Excel.Interfaces.WorksheetData;戻り値
イベントの詳細
onActivated
ワークシートがアクティブになったときに発生します。
readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;イベントの種類
注釈
例
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
sheet.onActivated.add(function (event) {
return Excel.run(async (context) => {
console.log("The activated worksheet ID is: " + event.worksheetId);
await context.sync();
});
});
await context.sync();
});
onChanged
特定のワークシートでデータが変更されたときに発生します。
readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;イベントの種類
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
sheet.onChanged.add(onChange);
await context.sync();
console.log("Added a worksheet-level data-changed event handler.");
});
onDeactivated
ワークシートが非アクティブ化されたときに発生します。
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;イベントの種類
注釈
例
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
sheet.onDeactivated.add(function (event) {
return Excel.run(async (context) => {
console.log("The deactivated worksheet is: " + event.worksheetId);
await context.sync();
});
});
await context.sync();
});
onSelectionChanged
特定のワークシートで選択内容が変更されたときに発生します。
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;イベントの種類
注釈
例
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
sheet.onSelectionChanged.add(function (event) {
return Excel.run(async (context) => {
console.log("The selected range has changed to: " + event.address);
await context.sync();
});
});
await context.sync();
});
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示