HtmlForgeX

API Reference

Class

DataTablesColumnBuilder

Namespace HtmlForgeX
Assembly HtmlForgeX

Fluent builder for DataTables column configuration

Inheritance

  • Object
  • DataTablesColumnBuilder

Constructors

Methods

public DataTablesColumnBuilder AddClass(Int32 columnIndex, String className) #
Returns: DataTablesColumnBuilder

Add CSS class to column

Parameters

columnIndex System.Int32 requiredposition: 0
className System.String requiredposition: 1
AddColumn(HtmlForgeX.DataTablesColumn arg1) #

Add a column to the collection

Parameters

arg1 HtmlForgeX.DataTablesColumn required
Column 3 overloads
public DataTablesColumnBuilder Column(String name, Action<DataTablesColumn> configure) #
Returns: DataTablesColumnBuilder

Add a column configuration

Parameters

targetIndex System.Int32 requiredposition: 0
configure System.Action{HtmlForgeX.DataTablesColumn} requiredposition: 1
Column(System.String name, System.Action{HtmlForgeX.DataTablesColumn} configure) #

Add a column configuration by name

Parameters

name System.String required
configure System.Action{HtmlForgeX.DataTablesColumn} required
public DataTablesColumnBuilder Column(Action<DataTablesColumnConfiguration> configure) #
Returns: DataTablesColumnBuilder

Configure column with fluent API

Parameters

configure System.Action{HtmlForgeX.DataTablesColumnConfiguration} requiredposition: 0
public DataTablesColumnBuilder DisableOrdering(params Int32[] columnIndexes) #
Returns: DataTablesColumnBuilder

Set column as non-orderable

Parameters

columnIndexes System.Int32[] requiredposition: 0
public DataTablesColumnBuilder DisableSearching(params Int32[] columnIndexes) #
Returns: DataTablesColumnBuilder

Set column as non-searchable

Parameters

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

Get configured columns

public DataTablesColumnBuilder HideColumns(params Int32[] columnIndexes) #
Returns: DataTablesColumnBuilder

Hide columns

Parameters

columnIndexes System.Int32[] requiredposition: 0
public DataTablesColumnBuilder SetType(Int32 columnIndex, DataTablesColumnType type) #
Returns: DataTablesColumnBuilder

Set column data type

Parameters

columnIndex System.Int32 requiredposition: 0
type HtmlForgeX.DataTablesColumnType requiredposition: 1
public DataTablesColumnBuilder SetWidth(Int32 columnIndex, String width) #
Returns: DataTablesColumnBuilder

Set column widths

Parameters

columnIndex System.Int32 requiredposition: 0
width System.String requiredposition: 1