Back to Devexpress

Worksheet.ClearFormats(CellRange) Method

officefileapi-devexpress-dot-spreadsheet-dot-worksheet-dot-clearformats-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md

latest6.8 KB
Original Source

Worksheet.ClearFormats(CellRange) Method

Removes cell formatting.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
void ClearFormats(
    CellRange range
)
vb
Sub ClearFormats(
    range As CellRange
)

Parameters

NameTypeDescription
rangeCellRange

A CellRange object specifying the cell range to clear.

|

Remarks

The ClearFormats method removes cell formatting only. Cell content, active hyperlinks and comments remain unchanged. Another way to do this is to apply the Normal style to a cell range via the CellRange.Style property.

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

  • Clear Cell Content

  • Clear Cell Formatting

  • Clear Cell Hyperlinks

  • Clear Cell Comments

View Example

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

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

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

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

See Also

Clear(CellRange)

ClearContents(CellRange)

ClearHyperlinks(CellRange)

ClearComments(CellRange)

DeleteCells

How to: Delete a Cell or Range of Cells

Worksheet Interface

Worksheet Members

DevExpress.Spreadsheet Namespace