HtmlForgeX

API Reference

Class

DataTablesExcelExportBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Fluent builder that generates a DataTables Buttons Excel customize(xlsx) function to tweak the workbook (sheet name, freeze header, column widths, number/date formats, auto-filter).

Inheritance

  • Object
  • DataTablesExcelExportBuilder

Methods

public DataTablesExcelExportBuilder AutoFilter(Boolean enable = true) #
Returns: DataTablesExcelExportBuilder

Enable auto-filter on the header row.

Parameters

enable System.Boolean = true optionalposition: 0
public DataTablesExcelExportBuilder ColumnWidth(Int32 columnIndex1Based, Double width) #
Returns: DataTablesExcelExportBuilder

Set an explicit width for a 1-based column index.

Parameters

columnIndex1Based System.Int32 requiredposition: 0
width System.Double requiredposition: 1
public DataTablesExcelExportBuilder FormatColumns(String excelFormatCode, params Int32[] columnIndexes1Based) #
Returns: DataTablesExcelExportBuilder

Apply an Excel number format code (e.g., "0", "0.00", "#,##0", "mm-dd-yy") to given columns.

Parameters

excelFormatCode System.String requiredposition: 0
columnIndexes1Based System.Int32[] requiredposition: 1
public DataTablesExcelExportBuilder FreezeHeaderRow(Boolean enable = true) #
Returns: DataTablesExcelExportBuilder

Freezes the top header row.

Parameters

enable System.Boolean = true optionalposition: 0
public DataTablesExcelExportBuilder SheetName(String name) #
Returns: DataTablesExcelExportBuilder

Sets the Excel sheet name.

Parameters

name System.String requiredposition: 0