HtmlForgeX

API Reference

Class

DataTablesGlobalConfig

Namespace HtmlForgeX
Assembly HtmlForgeX

Global configuration settings for DataTables across the document

Inheritance

  • Object
  • DataTablesGlobalConfig

Constructors

Properties

public Boolean EncodeCellValuesByDefault { get; set; } #

HTML-encodes plain cell values by default for DataTables generated from objects/dictionaries. Disable only when you intentionally render trusted HTML fragments in plain string properties.

public DataTablesRenderMode DefaultRenderMode { get; set; } #

Default rendering mode for all DataTables in the document

public Int32 AutoModeThreshold { get; set; } #

Threshold for automatic mode - switch to JavaScript rendering when row count exceeds this

public Boolean EnableDeferredRendering { get; set; } #

Enable deferred rendering globally for better performance

public Boolean LazyInitByDefault { get; set; } #

When true, DataTables initialization is deferred until the table becomes visible (e.g., inside inactive tabs, collapsed accordions, or wizard steps). This can drastically reduce initial load time for large reports with many tables.

public Boolean EnableProcessingIndicator { get; set; } #

Enables or disables the DataTables "processing" indicator globally.

public Int32 DefaultPageLength { get; set; } #

Default page length for all tables

public Nullable<Int32> SearchDelayMs { get; set; } #

Delay (in milliseconds) before applying the global search term while typing. When set, applies to tables that haven't set their own searchDelay.

public Boolean EnableServerSideProcessing { get; set; } #

Enable server-side processing globally

public Boolean DebugMode { get; set; } #

Enable debug mode for DataTables

public String DefaultColumnWidth { get; set; } #

Default column width for all columns

public Nullable<DataTablesColumnType> DefaultColumnType { get; set; } #

Default column type for all columns

public Nullable<DataTablesTextAlign> DefaultColumnAlignment { get; set; } #

Default column text alignment for all columns

public Nullable<DataTablesFontWeight> DefaultColumnFontWeight { get; set; } #

Default column font weight for all columns

public Nullable<DataTablesColumnStyle> DefaultColumnStyle { get; set; } #

Default column style for all columns

public String EmptyEnumerablePlaceholder { get; set; } #

Placeholder to display when enumerable properties are empty. If null, empty collections render as blank.

public String NullPlaceholder { get; set; } #

Placeholder to display when a cell value is null. If null, empty cells render as blank. Note: Table instances may still override via Settings().NullsAs(...).

public Nullable<DataTablesPreset> DefaultPreset { get; set; } #

Apply a pre-defined preset to all DataTables unless a table overrides it.

public Nullable<DataTablesDomPreset> DefaultDomPreset { get; set; } #

Global DOM preset (e.g., ToolbarTop, ButtonsAndFilter) when a table doesn't specify one.

public String DefaultDom { get; set; } #

Raw DOM layout string applied when no preset or table-level DOM is set.

public Boolean EnableStandardExportButtons { get; set; } #

Enable standard export buttons (Excel/CSV/PDF/Copy + Column Visibility) globally when a table hasn't added buttons.

public Int64 SafeClientExportCellThreshold { get; set; } #

When the estimated client-side export size exceeds this cell count, HtmlForgeX switches Excel/CSV/PDF/Copy buttons to a safer native export path that avoids DataTables' recursive exportData() implementation for very large tables. Set to 0 to disable the safeguard.

public Boolean EnableHeaderFilters { get; set; } #

Add a header filter row by default.

public Boolean EnableFooterFilters { get; set; } #

Add a footer filter row by default.

public Nullable<DataTablesColumnFilterPlacement> DefaultColumnFilterPlacement { get; set; } #

Preferred placement for native per-column filters when a table does not override it.

public Nullable<Int32> AlphabetFilterColumn { get; set; } #

Enable alphabet filter on the given column index by default (set to null to disable).

public Nullable<Boolean> DefaultResponsive { get; set; } #

Default responsive enable/disable. If null, the table decides (current default: enabled).

public Boolean ConstrainToContainerByDefault { get; set; } #

Wrap tables in a viewport div (overflow-x: auto) by default.

public Int32[] DefaultLengthMenu { get; set; } #

Default LengthMenu options (e.g., new[] { 10, 25, 50, 100 }). Applied when a table hasn't set its own.

public Nullable<DataTablesPageLengthPlacement> DefaultPageLengthPlacement { get; set; } #

Preferred placement for the native page-length selector when HtmlForgeX manages the DataTables layout.

public Nullable<DataTablesPagingPlacement> DefaultPagingPlacement { get; set; } #

Preferred placement for native pagination buttons when HtmlForgeX manages the DataTables layout.

public Nullable<DataTablesPageLengthLabelMode> DefaultPageLengthLabelMode { get; set; } #

Preferred label mode for the native page-length selector when a table does not override it.

public ValueTuple<Int32, String>[] DefaultOrder { get; set; } #

Default order (column index + direction) applied when the table hasn't set its own order.

public DataTablesOptions DefaultOptions { get; set; } #

Additional default DataTables options to merge into each table when not explicitly set there. Only null/missing table options are filled from this object; table-specific values win.

public DataTablesHeaderNamingOptions HeaderNaming { get; } #

Global header naming settings (acronyms, overrides). Disabled by default; enable to apply to all tables.

public DataTablesLabelerRegistry Labelers { get; } #

Global labelers registry used by smart value formatters (e.g., SmartLabel for enumerable details). Allows registering per-type and per-property labelers and customizing SmartLabel property order.

public Dictionary<String, Action<TargetsBuilder>> DefaultStatusMap { get; } #

Default mapping of status strings to highlight styles for convenience helpers. Can be overridden per-document or per-table via HighlightByStatus/HighlightOutcomes.

public DataTablesCallbackEvalPolicy CallbackEvalPolicy { get; set; } #

Global policy for reviving string callbacks to JavaScript functions at runtime. Defaults to Off for safety.

public List<IValueTransformer> DefaultTransformers { get; } #

Value transformers applied to every DataTablesTable by default (e.g., TemporalValueTransformer). Tables can add more via Settings(...).

public DataTablesSharedDataRegistry Shared { get; } #

Document‑level shared datasets registry used by multiple DataTables instances. Tables can publish normalized object rows under a key and other tables can reference the same key to reuse the dataset with different initial filters.