IXlColumn.ApplyFormatting(XlCellFormatting) Method

Applies the specified formatting settings to the entire column.

Namespace: DevExpress.Export.Xl

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

void ApplyFormatting(
    XlCellFormatting formatting
)

VB.NET

Sub ApplyFormatting(
    formatting As XlCellFormatting
)

Parameters

Name	Type	Description
formatting	XlCellFormatting	An XlCellFormatting object that specifies format characteristics to be applied to column cells.

Remarks

The XlCellFormatting object provides a set of properties and methods to change cell format settings.

• 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, etc.).
• To apply a predefined formatting that is based on the current document theme, use the XlCellFormatting.Themed method.
• To specify the custom formatting options for column 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 you can directly pass an object specifying the required format characteristics to the ApplyFormatting method without using unnecessary cast operators.

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ApplyFormatting(XlCellFormatting) method.

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#

excel-export-library-generate-sales-analysis-report/CS/XLExportExample/Form1.cs#L179

    column.WidthInPixels = 140;
    column.ApplyFormatting(numberFormat);
}

excel-export-library-generate-sales-report/CS/XLExportExampleSalesReport/Form1.cs#L180

    column.WidthInPixels = 117;
    column.ApplyFormatting(numberFormat);
}

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L33

if(gridColumn.DisplayFormat.FormatType == FormatType.DateTime)
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, true));
else if(gridColumn.DisplayFormat.FormatType != FormatType.None)

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

    column.WidthInPixels = 100;
    column.ApplyFormatting(numberFormat);
}

VB.NET

excel-export-library-generate-sales-analysis-report/VB/XLExportExample/Form1.vb#L164

    column.WidthInPixels = 140
    column.ApplyFormatting(numberFormat)
End Using

excel-export-library-generate-sales-report/VB/XLExportExampleSalesReport/Form1.vb#L192

    column.WidthInPixels = 117
    column.ApplyFormatting(numberFormat)
End Using

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L34

If gridColumn.DisplayFormat.FormatType = FormatType.DateTime Then
    column.ApplyFormatting(XlCellFormatting.FromNetFormat(gridColumn.DisplayFormat.FormatString, True))
ElseIf gridColumn.DisplayFormat.FormatType <> FormatType.None Then

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

    column.WidthInPixels = 100
    column.ApplyFormatting(numberFormat)
End Using