Excel.WorksheetSingleClickedEventArgs interface

注意

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

左クリック/タップイベントを発生させたワークシートに関する情報を提供します。Provides information about the worksheet that raised the left-clicked/tapped event.

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

プロパティ

address

特定のワークシートで左クリック/タップされたセルを表すアドレスを取得します。Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.

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

offsetX

左クリック/タップされたポイントから、左クリック/タップされたセルの左側 (RTL の場合は右側) の目盛線までの距離を、ポイント単位で表します。The distance, in points, from the left-clicked/tapped point to the left (right for RTL) gridline edge of the left-clicked/tapped cell.

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

offsetY

左クリック/タップされたポイントから、左クリック/タップされたセルの上側の目盛線までの距離を、ポイント単位で表します。The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.

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

type

イベントの種類を取得します。Gets the type of the event.

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

worksheetId

左クリック/タップされたワークシートの ID を取得します。Gets the id of the worksheet in which the cell was left-clicked/tapped.

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

プロパティの詳細

address

注意

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

特定のワークシートで左クリック/タップされたセルを表すアドレスを取得します。Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.

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

address: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onSingleClicked.add((event) => {
        return Excel.run((context) => {
            console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`);
            return context.sync();
        });
    });

    console.log("The worksheet click handler is registered.");

    await context.sync();
});

offsetX

注意

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

左クリック/タップされたポイントから、左クリック/タップされたセルの左側 (RTL の場合は右側) の目盛線までの距離を、ポイント単位で表します。The distance, in points, from the left-clicked/tapped point to the left (right for RTL) gridline edge of the left-clicked/tapped cell.

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

offsetX: number;

プロパティ値

number

offsetY

注意

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

左クリック/タップされたポイントから、左クリック/タップされたセルの上側の目盛線までの距離を、ポイント単位で表します。The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.

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

offsetY: number;

プロパティ値

number

type

注意

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

イベントの種類を取得します。Gets the type of the event.

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

type: "WorksheetSingleClicked";

プロパティ値

"WorksheetSingleClicked"

worksheetId

注意

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

左クリック/タップされたワークシートの ID を取得します。Gets the id of the worksheet in which the cell was left-clicked/tapped.

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

worksheetId: string;

プロパティ値

string