HtmlForgeX

API Reference

Class

DataTablesOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Configuration options for the DataTables JavaScript plugin.

Inheritance

  • Object
  • DataTablesOptions

Constructors

public DataTablesOptions() #

Properties

public Nullable<Int32> PageLength { get; set; } #
JsonPropertyName("pageLength") JsonIgnore(Condition = 3)

Default number of rows per page.

public Int32[] LengthMenu { get; set; } #
JsonPropertyName("lengthMenu") JsonIgnore(Condition = 3)

Available page length options.

public Nullable<Boolean> LengthChange { get; set; } #
JsonPropertyName("lengthChange") JsonIgnore(Condition = 3)

Shows or hides the native DataTables page-length selector.

public Nullable<Boolean> StateSave { get; set; } #
JsonPropertyName("stateSave") JsonIgnore(Condition = 3)

Enable DataTables state saving.

public Nullable<Int32> SearchDelay { get; set; } #
JsonPropertyName("searchDelay") JsonIgnore(Condition = 3)

Delay (in milliseconds) before applying the global search term while typing. Useful for very large tables to reduce redraw frequency.

public String ScrollY { get; set; } #
JsonPropertyName("scrollY") JsonIgnore(Condition = 3)

Vertical scroll height.

public Nullable<Boolean> ScrollCollapse { get; set; } #
JsonPropertyName("scrollCollapse") JsonIgnore(Condition = 3)

Enable collapsing the table height when fewer rows are present.

public Nullable<Boolean> AutoWidth { get; set; } #
JsonPropertyName("autoWidth") JsonIgnore(Condition = 3)

Automatically calculate column widths.

public Nullable<Boolean> DeferRender { get; set; } #
JsonPropertyName("deferRender") JsonIgnore(Condition = 3)

Defer rendering for speed on large data sets.

public Nullable<Boolean> Processing { get; set; } #
JsonPropertyName("processing") JsonIgnore(Condition = 3)

Show the processing indicator.

public Nullable<Boolean> ServerSide { get; set; } #
JsonPropertyName("serverSide") JsonIgnore(Condition = 3)

Enable server-side processing.

public Nullable<Int32> StateDuration { get; set; } #
JsonPropertyName("stateDuration") JsonIgnore(Condition = 3)

State saving duration in seconds (-1 to persist indefinitely).

public DataTablesLanguage Language { get; set; } #
JsonPropertyName("language") JsonIgnore(Condition = 3)

Localization options.

public String Dom { get; set; } #
JsonPropertyName("dom") JsonIgnore(Condition = 3)

DOM positioning configuration string.

public String PagingType { get; set; } #
JsonPropertyName("pagingType") JsonIgnore(Condition = 3)

Pagination type styling.

public List<DataTablesColumn> ColumnDefs { get; set; } #
JsonPropertyName("columnDefs") JsonIgnore(Condition = 3)

Column definitions for advanced configuration.

public List<DataTablesColumn> Columns { get; set; } #
JsonPropertyName("columns") JsonIgnore(Condition = 3)

Column configuration array.

public Object[][] Order { get; set; } #
JsonPropertyName("order") JsonIgnore(Condition = 3)

Default ordering configuration.

public List<DataTablesExport> Buttons { get; set; } #
JsonPropertyName("buttons") JsonIgnore(Condition = 3)

Buttons extension configuration.

public DataTablesRowGroup RowGroup { get; set; } #
JsonPropertyName("rowGroup") JsonIgnore(Condition = 3)

Row grouping configuration.

public DataTablesSearchBuilder SearchBuilder { get; set; } #
JsonPropertyName("searchBuilder") JsonIgnore(Condition = 3)

Search Builder configuration.

public DataTablesSearchPanes SearchPanes { get; set; } #
JsonPropertyName("searchPanes") JsonIgnore(Condition = 3)

Search Panes configuration.

public DataTablesFixedHeader FixedHeader { get; set; } #
JsonPropertyName("fixedHeader") JsonIgnore(Condition = 3)

Fixed Header configuration.

public DataTablesFixedColumns FixedColumns { get; set; } #
JsonPropertyName("fixedColumns") JsonIgnore(Condition = 3)

Fixed Columns configuration.

public Object Responsive { get; set; } #
JsonPropertyName("responsive") JsonIgnore(Condition = 3)

Responsive configuration.

public Object Select { get; set; } #
JsonPropertyName("select") JsonIgnore(Condition = 3)

Select extension configuration.

public Object Keys { get; set; } #
JsonPropertyName("keys") JsonIgnore(Condition = 3)

Key table navigation.

public Object ColReorder { get; set; } #
JsonPropertyName("colReorder") JsonIgnore(Condition = 3)

Column reordering.

public String RowCallback { get; set; } #
JsonPropertyName("rowCallback") JsonIgnore(Condition = 3)

Row callback function name.

public String HeaderCallback { get; set; } #
JsonPropertyName("headerCallback") JsonIgnore(Condition = 3)

Header callback function name.

public String FooterCallback { get; set; } #
JsonPropertyName("footerCallback") JsonIgnore(Condition = 3)

Footer callback function name.

public String DrawCallback { get; set; } #
JsonPropertyName("drawCallback") JsonIgnore(Condition = 3)

Draw callback function name.

public String InitComplete { get; set; } #
JsonPropertyName("initComplete") JsonIgnore(Condition = 3)

Init complete callback function name.

public String CreatedRow { get; set; } #
JsonPropertyName("createdRow") JsonIgnore(Condition = 3)

Created row callback function body.

public String StateSaveCallback { get; set; } #
JsonPropertyName("stateSaveCallback") JsonIgnore(Condition = 3)

State save callback function body.

public String StateLoadCallback { get; set; } #
JsonPropertyName("stateLoadCallback") JsonIgnore(Condition = 3)

State load callback function body.

public DataTablesColumnHighlighterConfig ColumnHighlighter { get; set; } #
JsonPropertyName("columnHighlighter") JsonIgnore(Condition = 3)

HtmlForgeX DataTables Column Highlighter configuration.

public DataTablesSearchHighlighterConfig SearchHighlighter { get; set; } #
JsonPropertyName("searchHighlighter") JsonIgnore(Condition = 3)

HTMLExtensions DataTables Search Highlighter configuration.

public DataTablesAjax Ajax { get; set; } #
JsonPropertyName("ajax") JsonIgnore(Condition = 3)

Ajax configuration for remote/server-side data.