Excel.WorksheetCollection class

ブックの一部であるワークシート オブジェクトのコレクションを表します。Represents a collection of worksheet objects that are part of the workbook.

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

Extends

プロパティ

context

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

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(name)

新しいワークシートをブックに追加します。ワークシートは、既存のワークシートの末尾に追加されます。新しく追加したワークシートをアクティブにする場合は、そのワークシートに対して ".activate() を呼び出します。Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call ".activate() on it.

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

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

あるブックの指定されたワークシートを現在のブックに挿入します。Inserts the specified worksheets of a workbook into the current workbook.

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

addFromBase64(base64File, sheetNamesToInsert, positionTypeString, relativeTo)

あるブックの指定されたワークシートを現在のブックに挿入します。Inserts the specified worksheets of a workbook into the current workbook.

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

getActiveWorksheet()

ブックの、現在作業中のワークシートを取得します。Gets the currently active worksheet in the workbook.

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

getCount(visibleOnly)

コレクションに含まれるワークシートの数を取得します。Gets the number of worksheets in the collection.

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

getFirst(visibleOnly)

コレクション内の最初のワークシートを取得します。Gets the first worksheet in the collection.

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

getItem(key)

名前または ID を使用して、ワークシート オブジェクトを取得します。Gets a worksheet object using its Name or ID.

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

getItemOrNullObject(key)

名前または ID を使用して、ワークシート オブジェクトを取得します。Gets a worksheet object using its Name or ID. ワークシートが存在しない場合は null オブジェクトを返します。If the worksheet does not exist, will return a null object.

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

getLast(visibleOnly)

コレクション内の最後のワークシートを取得します。Gets the last worksheet in the collection.

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

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(option)
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オブジェクトのメソッドを呼び出します。元Excel.WorksheetCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorksheetCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorksheetCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

イベント

onActivated

ブック内のすべてのワークシートがアクティブになったときに発生します。Occurs when any worksheet in the workbook is activated.

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

onAdded

新しいワークシートがブックに追加されるときに発生します。Occurs when a new worksheet is added to the workbook.

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

onCalculated

ブック内の任意のワークシートが計算されるときに発生します。Occurs when any worksheet in the workbook is calculated.

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

onChanged

ブックのワークシートが変更されたときに発生します。Occurs when any worksheet in the workbook is changed.

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

onColumnSorted

列を並べ替えたときに発生します。Occurs when sorting on columns.

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

onDeactivated

ブック内のすべてのワークシートが非アクティブ化されたときに発生します。Occurs when any worksheet in the workbook is deactivated.

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

onDeleted

ブックからワークシートが削除されるときに発生します。Occurs when a worksheet is deleted from the workbook.

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

onFiltered

ブック内でワークシートのフィルターが適用されたときに発生します。Occurs when any worksheet's filter is applied in the workbook.

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

onFormatChanged

ブック内のワークシートの書式が変更されたときに発生します。Occurs when any worksheet in the workbook has format changed.

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

onRowHiddenChanged

ブック内のすべてのワークシートの行の非表示状態が変更されたときに発生します。Occurs when any worksheet in the workbook has row hidden state changed.

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

onRowSorted

行を並べ替えたときに発生します。Occurs when sorting on rows.

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

onSelectionChanged

ワークシートで選択範囲を変更したときに発生します。Occurs when the selection changes on any worksheet.

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

onSingleClicked

ワークシートのコレクションで左クリック/タップ操作が行われるときに発生します。Occurs when left-clicked/tapped operation happens in the worksheet collection.

[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.

context: RequestContext;

プロパティ値

RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.Worksheet[];

プロパティ値

Excel.Worksheet[]

メソッドの詳細

add(name)

新しいワークシートをブックに追加します。ワークシートは、既存のワークシートの末尾に追加されます。新しく追加したワークシートをアクティブにする場合は、そのワークシートに対して ".activate() を呼び出します。Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call ".activate() on it.

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

add(name?: string): Excel.Worksheet;

パラメーター

name
string

省略可能。追加するワークシートの名前。指定する場合、名前は一意である必要があります。指定されていない場合は、Excel が新しいワークシートの名前を決定します。Optional. The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.

戻り値

Examples

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

addFromBase64(base64File, sheetNamesToInsert, positionType, relativeTo)

注意

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

あるブックの指定されたワークシートを現在のブックに挿入します。Inserts the specified worksheets of a workbook into the current workbook.

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

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

パラメーター

base64File
string

必須です。Required. 元のブックファイルを表す base64 でエンコードされた文字列。The base64-encoded string representing the source workbook file.

sheetNamesToInsert
string[]

省略可能。Optional. 挿入する個々のワークシートの名前を入力します。The names of individual worksheets to insert. 既定では、元のブックのすべてのワークシートが挿入されます。By default, all the worksheets from the source workbook are inserted.

positionType
Excel.WorksheetPositionType

省略可能。Optional. 現在のブックでは、新しいワークシートが挿入されます。Where in the current workbook the new worksheets will be inserted. 詳細については、「Excel. ワークシートの種類」を参照してください。See Excel.WorksheetPositionType for details. 既定値は "Start" です。Default is "Start".

relativeTo
Worksheet | string

省略可能。Optional. PositionType パラメーターに対して参照されている現在のブックのワークシート。The worksheet in the current workbook that is referenced for the positionType parameter. 既定値は null で、positionType に基づいて、現在のブックの先頭または末尾にワークシートを挿入します。Default is null and, based on positionType, it will insert worksheets at the start or end of the current workbook.

戻り値

OfficeExtension.ClientResult<string[]>

新しく挿入された各ワークシートに対応する id の配列を格納します。An array of ids corresponding to each newly inserted worksheet.

Examples

const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
    Excel.run((context) => {
        // strip off the metadata before the base64-encoded string
        const startIndex = (<string>(<FileReader>event.target).result).indexOf("base64,");
        const workbookContents = (<string>(<FileReader>event.target).result).substr(startIndex + 7);

        const sheets = context.workbook.worksheets;
        sheets.addFromBase64(
            workbookContents,
            null, // get all the worksheets 
            Excel.WorksheetPositionType.end // insert them after the current workbook's worksheets
            );
        return context.sync();
    });
};

// read in the file as a data URL so we can parse the base64-encoded string
reader.readAsDataURL(myFile.files[0]);

addFromBase64(base64File, sheetNamesToInsert, positionTypeString, relativeTo)

注意

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

あるブックの指定されたワークシートを現在のブックに挿入します。Inserts the specified worksheets of a workbook into the current workbook.

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

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

パラメーター

base64File
string

必須です。Required. 元のブックファイルを表す base64 でエンコードされた文字列。The base64-encoded string representing the source workbook file.

sheetNamesToInsert
string[]

省略可能。Optional. 挿入する個々のワークシートの名前を入力します。The names of individual worksheets to insert. 既定では、元のブックのすべてのワークシートが挿入されます。By default, all the worksheets from the source workbook are inserted.

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

省略可能。Optional. 現在のブックでは、新しいワークシートが挿入されます。Where in the current workbook the new worksheets will be inserted. 詳細については、「Excel. ワークシートの種類」を参照してください。See Excel.WorksheetPositionType for details. 既定値は "Start" です。Default is "Start".

relativeTo
Worksheet | string

省略可能。Optional. PositionType パラメーターに対して参照されている現在のブックのワークシート。The worksheet in the current workbook that is referenced for the positionType parameter. 既定値は null で、positionType に基づいて、現在のブックの先頭または末尾にワークシートを挿入します。Default is null and, based on positionType, it will insert worksheets at the start or end of the current workbook.

戻り値

OfficeExtension.ClientResult<string[]>

新しく挿入された各ワークシートに対応する id の配列を格納します。An array of ids corresponding to each newly inserted worksheet.

getActiveWorksheet()

ブックの、現在作業中のワークシートを取得します。Gets the currently active worksheet in the workbook.

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

getActiveWorksheet(): Excel.Worksheet;

戻り値

Examples

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

getCount(visibleOnly)

コレクションに含まれるワークシートの数を取得します。Gets the number of worksheets in the collection.

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

getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;

パラメーター

visibleOnly
boolean

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

戻り値

OfficeExtension.ClientResult<number>

getFirst(visibleOnly)

コレクション内の最初のワークシートを取得します。Gets the first worksheet in the collection.

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

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

getItem(key)

名前または ID を使用して、ワークシート オブジェクトを取得します。Gets a worksheet object using its Name or ID.

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

getItem(key: string): Excel.Worksheet;

パラメーター

key
string

ワークシートの名前または ID。The Name or ID of the worksheet.

戻り値

getItemOrNullObject(key)

名前または ID を使用して、ワークシート オブジェクトを取得します。Gets a worksheet object using its Name or ID. ワークシートが存在しない場合は null オブジェクトを返します。If the worksheet does not exist, will return a null object.

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

getItemOrNullObject(key: string): Excel.Worksheet;

パラメーター

key
string

ワークシートの名前または ID。The Name or ID of the worksheet.

戻り値

getLast(visibleOnly)

コレクション内の最後のワークシートを取得します。Gets the last worksheet in the collection.

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

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

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.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;

パラメーター

option
Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

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

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

パラメーター

propertyNames
string | string[]

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

戻り値

Examples

Excel.run(function (ctx) { 
    var worksheets = ctx.workbook.worksheets;
    worksheets.load('items');
    return ctx.sync().then(function() {
        for (var i = 0; i < worksheets.items.length; i++)
        {
            console.log(worksheets.items[i].name);
            console.log(worksheets.items[i].index);
        }
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(option)

load(option?: OfficeExtension.LoadOption): Excel.WorksheetCollection;

パラメーター

戻り値

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オブジェクトのメソッドを呼び出します。元Excel.WorksheetCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.WorksheetCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.WorksheetCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.WorksheetCollectionData;

戻り値

イベントの詳細

onActivated

ブック内のすべてのワークシートがアクティブになったときに発生します。Occurs when any worksheet in the workbook is activated.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Examples

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onActivated.add(onActivate);

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

onAdded

新しいワークシートがブックに追加されるときに発生します。Occurs when a new worksheet is added to the workbook.

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

readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets;
    sheet.onAdded.add(onWorksheetAdd);

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

onCalculated

ブック内の任意のワークシートが計算されるときに発生します。Occurs when any worksheet in the workbook is calculated.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

onChanged

ブックのワークシートが変更されたときに発生します。Occurs when any worksheet in the workbook is changed.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

onColumnSorted

注意

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

列を並べ替えたときに発生します。Occurs when sorting on columns.

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

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

onDeactivated

ブック内のすべてのワークシートが非アクティブ化されたときに発生します。Occurs when any worksheet in the workbook is deactivated.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Examples

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onDeactivated.add(onDeactivate);

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

onDeleted

ブックからワークシートが削除されるときに発生します。Occurs when a worksheet is deleted from the workbook.

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

readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>

onFiltered

注意

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

ブック内でワークシートのフィルターが適用されたときに発生します。Occurs when any worksheet's filter is applied in the workbook.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

onFormatChanged

ブック内のワークシートの書式が変更されたときに発生します。Occurs when any worksheet in the workbook has format changed.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

onRowHiddenChanged

注意

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

ブック内のすべてのワークシートの行の非表示状態が変更されたときに発生します。Occurs when any worksheet in the workbook has row hidden state changed.

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

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

onRowSorted

注意

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

行を並べ替えたときに発生します。Occurs when sorting on rows.

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

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

onSelectionChanged

ワークシートで選択範囲を変更したときに発生します。Occurs when the selection changes on any worksheet.

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

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

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

onSingleClicked

注意

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

ワークシートのコレクションで左クリック/タップ操作が行われるときに発生します。Occurs when left-clicked/tapped operation happens in the worksheet collection.

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

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

戻り値

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>