Worksheet.ClearContents(Range) Method
Removes cell content.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v18.2.Core.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| range | Range | A Range 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 Range.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 Range 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.ClearContentsmethod, or assign the Range.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 Range.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.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655
// 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"]);