Skip to main content
Row

Worksheet.ClearHyperlinks(CellRange) Method

Removes cell hyperlinks.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

void ClearHyperlinks(
    CellRange range
)

Parameters

Name Type Description
range CellRange

A CellRange object specifying the cell range to clear.

Remarks

The ClearHyperlinks method removes all active hyperlinks from the specified cell range. Cell content and formatting remain unchanged. Another way to do this is to use the HyperlinkCollection.Remove or HyperlinkCollection.RemoveAt method of the Worksheet.Hyperlinks collection. Note, that these methods leave hyperlink text in a cell, but remove cell formatting.

To separately remove cell content, formatting, comments or clear a cell range completely, call the Worksheet.ClearContents, Worksheet.ClearFormats, Worksheet.ClearComments or Worksheet.Clear method, respectively. To delete entire cells from the worksheet, use the Worksheet.DeleteCells method (see the How to: Delete a Cell or Range of Cells example).

To clear cells, you can also use the range’s Clear* extension methods, defined by the RangeExtensions class (RangeExtensions.Clear, RangeExtensions.ClearContents, RangeExtensions.ClearFormats, RangeExtensions.ClearHyperlinks and RangeExtensions.ClearComments). These extension methods are accessible as methods of the CellRange object and called by using the instance method syntax.

Example

This example demonstrates how to clear worksheet cells.

View Example

// Remove all cell information (content, formatting, hyperlinks and comments).
worksheet.Clear(worksheet["C2:D2"]);

// Remove cell content.
worksheet.ClearContents(worksheet["C3"]);
worksheet["D3"].Value = null;

// Remove cell formatting.
worksheet.ClearFormats(worksheet["C4"]);
worksheet["D4"].Style = workbook.Styles.DefaultStyle;

// Remove hyperlinks from cells.
worksheet.ClearHyperlinks(worksheet["C5"]);

Hyperlink hyperlinkD5 = worksheet.Hyperlinks.GetHyperlinks(worksheet["D5"])[0];
worksheet.Hyperlinks.Remove(hyperlinkD5);

// Remove comments from cells.
worksheet.ClearComments(worksheet["C6"]);

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClearHyperlinks(CellRange) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also