Edit

Share via

Excel.ClearApplyTo enum

  • Reference
Package:
excel

Remarks

[ API set: ExcelApi 1.1 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml

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

    const productsRange = sheet.getRange("A3:A11");
    productsRange.load("values");

    await context.sync();

    // Clear all hyperlinks.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);

        // Clear the hyperlink.
        // This removes the hyperlink but does not update text format.
        cellRange.clear(Excel.ClearApplyTo.hyperlinks);

        // Update text format.
        cellRange.format.font.underline = Excel.RangeUnderlineStyle.none;
        cellRange.format.font.color = "#000000";
    }

    await context.sync();
});

Fields

all = "All"

Clears everything in the range.
contents = "Contents"

Clears the contents of the range, leaving formatting intact.
formats = "Formats"

Clears all formatting for the range, leaving values intact.
hyperlinks = "Hyperlinks"

Clears all hyperlinks, but leaves all content and formatting intact.
removeHyperlinks = "RemoveHyperlinks"

Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation intact.