Fill.PatternType Property

Gets or sets the cell background pattern.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

PatternType PatternType { get; set; }

VB.NET

Property PatternType As PatternType

Property Value

Type	Description
PatternType	A PatternType enumeration member that specifies the pattern for the cell shading. Default is None.

Available values:

Show 19 items

Name	Description
None	No background (solid color or fill pattern) is applied to a cell.
Solid	Specifies that a cell is filled with a solid Fill.BackgroundColor color.
MediumGray	Specifies the 50% gray pattern.
DarkGray	Specifies the 75% gray pattern.
LightGray	Specifies the 25% gray pattern.
DarkHorizontal	Specifies a pattern that is a series of thick horizontal stripes.
DarkVertical	Specifies a pattern that is a series of thick vertical stripes.
DarkDown	Specifies a pattern that is a series of thick downward diagonal stripes.
DarkUp	Specifies a pattern that is a series of thick upward diagonal stripes.
DarkGrid	Specifies the thick grid pattern.
DarkTrellis	Specifies the thick diagonal trellis pattern.
LightHorizontal	Specifies a pattern that is a series of thin horizontal stripes.
LightVertical	Specifies a pattern that is a series of thin vertical stripes.
LightDown	Specifies a pattern that is a series of thin downward diagonal stripes.
LightUp	Specifies a pattern that is a series of thin upward diagonal stripes.
LightGrid	Specifies the thin grid pattern.
LightTrellis	Specifies the thin diagonal trellis pattern.
Gray125	Specifies the 12.5% gray pattern.
Gray0625	Specifies the 6.25% gray pattern.

Remarks

To specify the cell background characteristics, use the Fill.BackgroundColor, PatternType and Fill.PatternColor properties of the Fill object.

By default, the PatternType property is set to PatternType.None. When you set the Fill.BackgroundColor property, the PatternType property value is automatically changed to PatternType.Solid.

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.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the PatternType 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#

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/FormattingActions.cs#L237

rangeFormatting.Fill.BackgroundColor = Color.LightBlue;
rangeFormatting.Fill.PatternType = PatternType.LightHorizontal;
rangeFormatting.Fill.PatternColor = Color.Violet;

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/FormattingActions.vb#L240

rangeFormatting.Fill.BackgroundColor = Color.LightBlue
rangeFormatting.Fill.PatternType = PatternType.LightHorizontal
rangeFormatting.Fill.PatternColor = Color.Violet