XlCellFormatting Class
Represents the object that specifies cell format characteristics.
Namespace: DevExpress.Export.Xl
Assembly: DevExpress.Printing.v19.1.Core.dll
Declaration
Related API Members
The following members return XlCellFormatting objects:
Remarks
The XlCellFormatting object provides a set of properties and methods you can use to change cell format settings.
Predefined formatting
To format cells using the predefined format settings corresponding to one of the Microsoft® Excel® styles, use static properties of the XlCellFormatting class (XlCellFormatting.Bad, XlCellFormatting.Good, XlCellFormatting.Neutral, XlCellFormatting.Calculation, etc.). For details on how to specify predefined formatting for worksheet cells, refer to the How to: Apply Predefined Formatting to a Cell example.
Themed formatting
To format cells using a predefined format that is based on the document theme applied to the workbook (IXlDocument.Theme), utilize the XlCellFormatting.Themed method. For an example, refer to the How to: Apply Themed Formatting to a Cell topic.
Custom formatting
To specify the custom formatting options for cells, use properties inherited from the XlFormatting class: XlFormatting.Fill, XlFormatting.Font, XlFormatting.Alignment, XlFormatting.Border and XlFormatting.NumberFormat. Moreover, the XlCellFormatting object implements implicit conversion from the XlFill, XlFont, XlCellAlignment, XlBorder and XlNumberFormat objects, so that no cast expressions are required when assigning objects of the supported types to the XlCellFormatting instance.
To apply the specified format options to a cell, pass the corresponding XlCellFormatting object to the IXlCell.ApplyFormatting method as a parameter, or assign it to the IXlCell.Formatting property. Note that you can also share format settings with multiple cells in a row at once by utilizing the IXlRow.BlankCells and IXlRow.BulkCells methods.
To format the entire row or column, use the IXlRow.ApplyFormatting and IXlColumn.ApplyFormatting methods, or IXlRow.Formatting and IXlColumn.Formatting properties, respectively.
For more information on how to format cells in a worksheet, see the How to: Format a Cell document and the Formatting section of examples.
Example
// Create a new document and begin to write it to the specified stream.
using (IXlDocument document = exporter.CreateDocument(stream)) {
// Specify formatting settings to be applied to document content.
XlCellFormatting formatting = new XlCellFormatting();
// Specify cell background color.
formatting.Fill = XlFill.SolidFill(XlColor.FromArgb(0xCE, 0x8B, 0xDA));
// Specify font settings (font name, color, size and style).
formatting.Font = new XlFont();
formatting.Font.Name = "MV Boli";
formatting.Font.SchemeStyle = XlFontSchemeStyles.None;
formatting.Font.Size = 16;
formatting.Font.Color = Color.Wheat;
formatting.Font.Bold = true;
// Specify the alignment of cell content.
formatting.Alignment = XlCellAlignment.FromHV(XlHorizontalAlignment.Center, XlVerticalAlignment.Center);
// Specify outside border settings.
formatting.Border = XlBorder.OutlineBorders(XlColor.FromArgb(0x47, 0x7B, 0xD1), XlBorderLineStyle.Thick);
// Create a new worksheet.
using (IXlSheet sheet = document.CreateSheet()) {
// Create the first column and set its width.
using (IXlColumn column = sheet.CreateColumn())
column.WidthInPixels = 180;
// Create the first row in the worksheet.
using (IXlRow row = sheet.CreateRow()){
// Create a cell and specify its format settings.
using (IXlCell cell = row.CreateCell())
{
cell.Value = "Custom Format";
cell.ApplyFormatting(formatting);
}
}
}
}