Formatting Interface
Provides access to cell format characteristics.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v17.2.Core.dll
Declaration
Related API Members
The following members accept/return Formatting objects:
Remarks
The Formatting interface provides properties to change cell format settings (Formatting.Alignment, Formatting.Borders, Formatting.Fill, Formatting.Font, Formatting.NumberFormat, etc.). The Range 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 Range.BeginUpdateFormatting - Range.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 Range.BeginUpdateFormatting - Range.EndUpdateFormatting paired methods.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655
// 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.
Range 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);
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the Formatting interface.
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.