HtmlForgeX

API Reference

Class

DataTablesExportBuilder

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/DataTables/Builders/DataTablesExportBuilder.cs:7

Fluent builder for DataTables export configuration

Inheritance

  • Object
  • DataTablesExportBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

Methods

public DataTablesExportBuilder ColumnVisibility(String text = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:74
Returns: DataTablesExportBuilder

Add column visibility toggle button

Parameters

text System.String = null optionalposition: 0
public DataTablesExportBuilder ConfigureAll(Action<DataTablesExportOptions> configure) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:96
Returns: DataTablesExportBuilder

Configure export options for all buttons

Parameters

configure System.Action{HtmlForgeX.DataTablesExportOptions} requiredposition: 0
public DataTablesExportBuilder Copy(String text = null, String title = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:50
Returns: DataTablesExportBuilder

Add Copy to clipboard button

Parameters

text System.String = null optionalposition: 0
title System.String = null optionalposition: 1
public DataTablesExportBuilder CSV(String text = null, String filename = null, String title = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:24
Returns: DataTablesExportBuilder

Add CSV export button

Parameters

text System.String = null optionalposition: 0
filename System.String = null optionalposition: 1
title System.String = null optionalposition: 2
public DataTablesExportBuilder Custom(Action<DataTablesExport> configure) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:85
Returns: DataTablesExportBuilder

Add custom export button

Parameters

configure System.Action{HtmlForgeX.DataTablesExport} requiredposition: 0
public DataTablesExportBuilder Excel(String text = null, String filename = null, String title = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:11
Returns: DataTablesExportBuilder

Add Excel export button

Parameters

text System.String = null optionalposition: 0
filename System.String = null optionalposition: 1
title System.String = null optionalposition: 2
public DataTablesExportBuilder ExcludeColumns(params Int32[] columnIndexes) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:126
Returns: DataTablesExportBuilder

Exclude specific columns from export

Parameters

columnIndexes System.Int32[] requiredposition: 0
GetExports() #

Get configured exports

public DataTablesExportBuilder IncludeColumns(params Int32[] columnIndexes) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:135
Returns: DataTablesExportBuilder

Include only specific columns in export

Parameters

columnIndexes System.Int32[] requiredposition: 0
public DataTablesExportBuilder PDF(String text = null, String filename = null, String title = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:37
Returns: DataTablesExportBuilder

Add PDF export button

Parameters

text System.String = null optionalposition: 0
filename System.String = null optionalposition: 1
title System.String = null optionalposition: 2
public DataTablesExportBuilder Print(String text = null, String title = null) #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:62
Returns: DataTablesExportBuilder

Add Print button

Parameters

text System.String = null optionalposition: 0
title System.String = null optionalposition: 1
public DataTablesExportBuilder SelectedRowsOnly() #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:118
Returns: DataTablesExportBuilder

Set export options to selected rows only

public DataTablesExportBuilder VisibleColumnsOnly() #
Containers/DataTables/Builders/DataTablesExportBuilder.cs:110
Returns: DataTablesExportBuilder

Set export options to visible columns only