Excel.WorksheetSingleClickedEventArgs interface

パッケージ:

excel

左クリックまたはタップされたイベントとその関連ワークシートに関する情報を提供します。

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

address	特定のワークシートで左クリック/タップされたセルを表すアドレスを取得します。
offsetX	左クリックまたはタップされたセルの左クリック/タップされた点から左 (右から左の言語の場合は右) の枠線の端までの距離 (ポイント単位)。
offsetY	左クリック/タップされたポイントから、左クリック/タップされたセルの上側の目盛線までの距離を、ポイント単位で表します。
type	イベントの種類を取得します。
worksheetId	セルが左クリックまたはタップされたワークシートの ID を取得します。

プロパティの詳細

address

特定のワークシートで左クリック/タップされたセルを表すアドレスを取得します。

address: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-worksheet-single-click.yaml

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

左クリックまたはタップされたセルの左クリック/タップされた点から左 (右から左の言語の場合は右) の枠線の端までの距離 (ポイント単位)。

offsetX: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

offsetY

左クリック/タップされたポイントから、左クリック/タップされたセルの上側の目盛線までの距離を、ポイント単位で表します。

offsetY: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

type

イベントの種類を取得します。

type: "WorksheetSingleClicked";

プロパティ値

"WorksheetSingleClicked"

注釈

[ API セット: ExcelApi 1.10 ]

worksheetId

セルが左クリックまたはタップされたワークシートの ID を取得します。

worksheetId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]