Worksheet.ClearContents(CellRange) Method

Removes cell content.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void ClearContents(
    CellRange range
)

VB.NET

Sub ClearContents(
    range As CellRange
)

Parameters

Name	Type	Description
range	CellRange	A CellRange object specifying the cell range to clear.

Remarks

The ClearContents method removes cell data (value and formula) only. Cell formatting and comments remain unchanged. Another way to do this is to assign the CellRange.Value property to null or to CellValue.Empty.

To separately remove cell formatting, hyperlinks, comments or clear a cell range completely, call the Worksheet.ClearFormats, Worksheet.ClearHyperlinks, 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.

• Clear All

  To remove all cell information (content, formatting, hyperlinks and comments), call the Worksheet.Clear method.

• Clear Cell Content

  To remove cell content only (value and formula), call the Worksheet.ClearContents method, or assign the CellRange.Value property to null or to CellValue.Empty.

• Clear Cell Formatting

  To remove cell formatting only, call the Worksheet.ClearFormats method, or apply the Normal style to cells via the CellRange.Style property.

• Clear Cell Hyperlinks

  To remove any hyperlinks contained in a cell or cell range, call the Worksheet.ClearHyperlinks method. This method removes an active hyperlink from a cell, but leaves its descriptive text formatted as a hyperlink.

  You can also get hyperlinks contained in the specified cell range via the HyperlinkCollection.GetHyperlinks method and remove them using the HyperlinkCollection.Remove method of the Worksheet.Hyperlinks collection. In this case, hyperlink text is left in the cell, but cell formatting is removed.

• Clear Cell Comments

  To remove any comments contained in a cell or cell range, call the Worksheet.ClearComments method, or remove comments from the worksheet’s Worksheet.Comments collection via the CommentCollection.Remove or CommentCollection.RemoveAt method.

View Example

CellActions.cs

// 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"]);

CellActions.vb

' Remove all cell information (content, formatting, hyperlinks and comments).
worksheet.Clear(worksheet("C2:D2"))

' Remove cell content.
worksheet.ClearContents(worksheet("C3"))
worksheet("D3").Value = Nothing

' Remove cell formatting.
worksheet.ClearFormats(worksheet("C4"))
worksheet("D4").Style = workbook.Styles.DefaultStyle

' Remove hyperlinks from cells.
worksheet.ClearHyperlinks(worksheet("C5"))

Dim hyperlinkD5 As Hyperlink = worksheet.Hyperlinks.GetHyperlinks(worksheet("D5"))(0)
worksheet.Hyperlinks.Remove(hyperlinkD5)

' Remove comments from cells.
worksheet.ClearComments(worksheet("C6"))

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClearContents(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.

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/CellActions.vb#L199

' Remove cell content.
worksheet.ClearContents(worksheet("C3"))
worksheet("D3").Value = Nothing