Fill.BackgroundColor Property

Gets or sets the cell background color.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

Color BackgroundColor { get; set; }

VB.NET

Property BackgroundColor As Color

Property Value

Type	Description
Color	A Color value that specifies the cell background color.

Remarks

To specify the background characteristics of a cell, use the BackgroundColor, Fill.FillType, Fill.Gradient, Fill.PatternType and Fill.PatternColor properties of the Fill object. Note that when you set the BackgroundColor property for a cell with no background (Fill.PatternType is set to PatternType.None), this cell background pattern type is automatically changed to PatternType.Solid.

Note

If the BackgroundColor property is set to a non-empty value, gradient effects are not applicable.

To access the Fill object, use the Formatting.Fill property.

• To specify the background of an individual cell, access the Fill object using the cell’s Formatting.Fill property directly.
• To specify the background of a cell range, modify the Fill object within the Range.BeginUpdateFormatting - Range.EndUpdateFormatting method pair.
• To share the same background settings between multiple cells in one step, apply the style with the specified background to the required cells. To specify the cell style background, access the Style object from the IWorkbook.Styles collection and use this style’s Formatting.Fill property within the Formatting.BeginUpdate-Formatting.EndUpdate paired methods to access and modify the Fill object.

For examples on how to specify formatting for an individual cell and cell range or modify a style, refer to the How to: Format a Cell or Range of Cells or How to: Create or Modify a Style document.

Note

You can also set a background color for an individual cell or range of cells via the Range.FillColor property.

To specify the cell font color, use the SpreadsheetFont.Color property of the SpreadsheetFont object accessed via the Formatting.Font property. For details, review the How to: Change Cell Font and Background Color example.

Example

This example demonstrates how to format color characteristics (font and background colors) for an individual cell and range of cells.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339

FormattingActions.cs

// Format an individual cell.
worksheet.Cells["A1"].Font.Color = Color.Red;
worksheet.Cells["A1"].FillColor = Color.Yellow;

// Format a range of cells.
Range range = worksheet.Range["C3:D4"];
Formatting rangeFormatting = range.BeginUpdateFormatting();
rangeFormatting.Font.Color = Color.Blue;
rangeFormatting.Fill.BackgroundColor = Color.LightBlue;
rangeFormatting.Fill.PatternType = PatternType.LightHorizontal;
rangeFormatting.Fill.PatternColor = Color.Violet;
range.EndUpdateFormatting(rangeFormatting);

FormattingActions.vb

' Format an individual cell.
worksheet.Cells("A1").Font.Color = Color.Red
worksheet.Cells("A1").FillColor = Color.Yellow

' Format a range of cells.
Dim range As Range = worksheet.Range("C3:D4")
Dim rangeFormatting As Formatting = range.BeginUpdateFormatting()
rangeFormatting.Font.Color = Color.Blue
rangeFormatting.Fill.BackgroundColor = Color.LightBlue
rangeFormatting.Fill.PatternType = PatternType.LightHorizontal
rangeFormatting.Fill.PatternColor = Color.Violet
range.EndUpdateFormatting(rangeFormatting)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BackgroundColor property.

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.

C#

how-to-apply-conditional-formatting-to-a-range-of-cells-wpf-spreadsheet-e4968/CS/ConditionalFormatting_WPF_Examples/SpreadsheetActions/ConditionalFormatting.cs#L74

// Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xFA, 0xF7, 0xAA);
// Set the font color to red.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.cs#L77

// Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xFA, 0xF7, 0xAA);
// Set the font color to red.

how-to-apply-conditional-formatting-to-a-range-of-cells-e4929/CS/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.cs#L75

// Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xFA, 0xF7, 0xAA);
// Set the font color to red.

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.cs#L20

foreach (Cell cell in searchResult)
    cell.Fill.BackgroundColor = Color.LightGreen;
#endregion #SimpleSearch

wpf-spreadsheetcontrol-api-part-2-e4944/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/SearchActions.cs#L27

foreach (Cell cell in searchResult)
    cell.Fill.BackgroundColor = System.Drawing.Color.LightGreen;
#endregion #SimpleSearch

VB.NET

how-to-apply-conditional-formatting-to-a-range-of-cells-wpf-spreadsheet-e4968/VB/ConditionalFormatting_WPF_Examples_VB/SpreadsheetActions/ConditionalFormattingAction.vb#L68

' Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HFA, &HF7, &HAA)
' Set the font color to red.

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/SpreadsheetActions/ConditionalFormatting.vb#L69

' Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HFA, &HF7, &HAA)
' Set the font color to red.

how-to-apply-conditional-formatting-to-a-range-of-cells-e4929/VB/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.vb#L70

' Set the background color to yellow.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HFA, &HF7, &HAA)
' Set the font color to red.

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/SearchActions.vb#L21

For Each cell As Cell In searchResult
    cell.Fill.BackgroundColor = Color.LightGreen
Next cell

wpf-spreadsheetcontrol-api-part-2-e4944/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/SearchActions.vb#L24

For Each cell As Cell In searchResult
    cell.Fill.BackgroundColor = System.Drawing.Color.LightGreen
Next cell