Excel.RangeHyperlink interface

ハイパーリンク (xhl) オブジェクトを取得/設定するために必要な文字列を表します。Represents the necessary strings to get/set a hyperlink (XHL) object.

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

プロパティ

address

ハイパーリンクの URL ターゲットを表します。Represents the url target for the hyperlink.

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

documentReference

ハイパーリンクのドキュメント参照先を表します。Represents the document reference target for the hyperlink.

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

screenTip

ハイパーリンクの上にカーソルを合わせると表示される文字列を表します。Represents the string displayed when hovering over the hyperlink.

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

textToDisplay

該当する範囲内の左上端のセルに表示される文字列を表します。Represents the string that is displayed in the top left most cell in the range.

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

プロパティの詳細

address

ハイパーリンクの URL ターゲットを表します。Represents the url target for the hyperlink.

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

address?: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

documentReference

ハイパーリンクのドキュメント参照先を表します。Represents the document reference target for the hyperlink.

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

documentReference?: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A9:A11");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a location within the workbook
    // for each product name in the second table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Navigate to the '" + cellText + "' worksheet",
            documentReference: cellText + "!A1"
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

screenTip

ハイパーリンクの上にカーソルを合わせると表示される文字列を表します。Represents the string displayed when hovering over the hyperlink.

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

screenTip?: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

textToDisplay

該当する範囲内の左上端のセルに表示される文字列を表します。Represents the string that is displayed in the top left most cell in the range.

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

textToDisplay?: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});