XlFormatting.Font Property

Gets or sets font settings to be applied to the cell content.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v19.2.Core.dll

Declaration

C#

public XlFont Font { get; set; }

VB.NET

Public Property Font As XlFont

Property Value

Type	Description
XlFont	An XlFont object that specifies cell font attributes.

Remarks

To specify the font characteristics of the cell content, use the Font property of the XlCellFormatting object, which controls the format settings of worksheet cells. The XlFont object provides a set of properties that you can use to set different font attributes (XlFontBase.Name, XlFontBase.Size, XlFontBase.Bold, XlFontBase.Italic, XlFont.Color, etc.).

To apply font characteristics to a cell, assign the specified XlCellFormatting instance to the IXlCell.Formatting property or pass it to the IXlCell.ApplyFormatting method as a parameter, as shown in the example below. Note that the XlCellFormatting object supports implicit conversion from the XlFont object, so that you can directly apply font settings to a cell without using unnecessary cast operators. For more information on how to set different characteristics of a cell font, refer to the How to: Configure Cell Font Settings topic.

Example

C#

// 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);
            }
        }
    }
}

VB.NET

' Create a new document and begin to write it to the specified stream. 
Using document As IXlDocument = exporter.CreateDocument(stream)

    ' Specify formatting settings to be applied to document content.
    Dim formatting As New XlCellFormatting()

    ' Specify cell background color.
    formatting.Fill = XlFill.SolidFill(XlColor.FromArgb(&HCE, &H8B, &HDA))

    ' 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(&H47, &H7B, &HD1), XlBorderLineStyle.Thick)

    ' Create a new worksheet. 
    Using sheet As IXlSheet = document.CreateSheet()

        ' Create the first column and set its width.
        Using column As IXlColumn = sheet.CreateColumn()
            column.WidthInPixels = 180
        End Using

        ' Create the first row in the worksheet.
        Using row As IXlRow = sheet.CreateRow()
            ' Create a cell and specify its format settings.
            Using cell As IXlCell = row.CreateCell()
                cell.Value = "Custom Format"
                cell.ApplyFormatting(formatting)
            End Using
        End Using
    End Using
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Font 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-use-the-excel-export-api-to-generate-a-sales-report-t251810/CS/XLExportExampleSalesReport/Form1.cs#L28

headerRowFormatting = new XlCellFormatting();
headerRowFormatting.Font = XlFont.BodyFont();
headerRowFormatting.Font.Bold = true;

how-to-use-the-excel-export-api-to-generate-a-list-of-employees-t251723/CS/XLExportExample/Form1.cs#L27

evenRowFormatting = new XlCellFormatting();
evenRowFormatting.Font = new XlFont();
evenRowFormatting.Font.Name = "Century Gothic";

VB.NET

how-to-use-the-excel-export-api-to-generate-a-sales-report-t251810/VB/XLExportExampleSalesReport/Form1.vb#L30

headerRowFormatting = New XlCellFormatting()
headerRowFormatting.Font = XlFont.BodyFont()
headerRowFormatting.Font.Bold = True

how-to-use-the-excel-export-api-to-generate-a-list-of-employees-t251723/VB/XLExportExample/Form1.vb#L29

evenRowFormatting = New XlCellFormatting()
evenRowFormatting.Font = New XlFont()
evenRowFormatting.Font.Name = "Century Gothic"