Formatting Interface

Provides access to cell format characteristics.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public interface Formatting

VB.NET

Public Interface Formatting

Related API Members

The following members return Formatting objects:

• CellRange.BeginUpdateFormatting()
• ISupportsFormatting.Formatting

Remarks

The Formatting interface provides properties to change cell format settings (Formatting.Alignment, Formatting.Borders, Formatting.Fill, Formatting.Font, Formatting.NumberFormat, etc.). The CellRange and Style interfaces are inherited from the Formatting interface, so you can use all these properties to perform direct cell formatting and create styles to apply a predefined set of format attributes to multiple cells.

• To format an individual cell, use the cell’s properties that are inherited from the Formatting interface directly.
• To format a cell range, modify the Formatting object within the CellRange.BeginUpdateFormatting - CellRange.EndUpdateFormatting method pair.
• To share the same format settings between multiple cells in one step, apply the style with the specified format characteristics to the required cells. Access the Style object from the IWorkbook.Styles collection and modify the style’s properties inherited from the Formatting interface within the Formatting.BeginUpdate-Formatting.EndUpdate paired methods.

For more information, see the Formatting Cells document and the Formatting Cells section of examples.

Example

This example demonstrates how to format cells in a worksheet.

• To format an individual cell, access the corresponding Cell object and modify its properties (for example Formatting.Font, Formatting.Fill, Formatting.Borders, Formatting.Alignment and Formatting.NumberFormat).
• To format a range of cells, access and modify the Formatting object via the CellRange.BeginUpdateFormatting - CellRange.EndUpdateFormatting paired methods.

View Example

FormattingActions.cs

// Access the cell to be formatted.
Cell cell = worksheet.Cells["B2"];

// Specify font settings (font name, color, size and style).
cell.Font.Name = "MV Boli";
cell.Font.Color = Color.Blue;
cell.Font.Size = 14;
cell.Font.FontStyle = SpreadsheetFontStyle.Bold;

// Specify cell background color.
cell.Fill.BackgroundColor = Color.LightSkyBlue;

// Specify text alignment in the cell. 
cell.Alignment.Vertical = SpreadsheetVerticalAlignment.Center;
cell.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center;
// Access the range of cells to be formatted.
CellRange range = worksheet.Range["C3:E6"];

// Begin updating of the range formatting. 
Formatting rangeFormatting = range.BeginUpdateFormatting();

// Specify font settings (font name, color, size and style).
rangeFormatting.Font.Name = "MV Boli";
rangeFormatting.Font.Color = Color.Blue;
rangeFormatting.Font.Size = 14;
rangeFormatting.Font.FontStyle = SpreadsheetFontStyle.Bold;

// Specify cell background color.
rangeFormatting.Fill.BackgroundColor = Color.LightSkyBlue;

// Specify text alignment in cells.
rangeFormatting.Alignment.Vertical = SpreadsheetVerticalAlignment.Center;
rangeFormatting.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center;

// End updating of the range formatting.
range.EndUpdateFormatting(rangeFormatting);

FormattingActions.vb

' Access the cell to be formatted.
Dim cell As Cell = worksheet.Cells("B2")

' Specify font settings (font name, color, size and style).
cell.Font.Name = "MV Boli"
cell.Font.Color = Color.Blue
cell.Font.Size = 14
cell.Font.FontStyle = SpreadsheetFontStyle.Bold

' Specify cell background color.
cell.Fill.BackgroundColor = Color.LightSkyBlue

' Specify text alignment in the cell. 
cell.Alignment.Vertical = SpreadsheetVerticalAlignment.Center
cell.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center
' Access the range of cells to be formatted.
Dim range As CellRange = worksheet.Range("C3:E6")

' Begin updating of the range formatting. 
Dim rangeFormatting As Formatting = range.BeginUpdateFormatting()

' Specify font settings (font name, color, size and style).
rangeFormatting.Font.Name = "MV Boli"
rangeFormatting.Font.Color = Color.Blue
rangeFormatting.Font.Size = 14
rangeFormatting.Font.FontStyle = SpreadsheetFontStyle.Bold

' Specify cell background color.
rangeFormatting.Fill.BackgroundColor = Color.LightSkyBlue

' Specify text alignment in cells.
rangeFormatting.Alignment.Vertical = SpreadsheetVerticalAlignment.Center
rangeFormatting.Alignment.Horizontal = SpreadsheetHorizontalAlignment.Center

' End updating of the range formatting.
range.EndUpdateFormatting(rangeFormatting)