API Reference
DataTablesSettings
Settings sub‑builder for DataTablesTable to keep the root API lean.
Inheritance
- Object
- DataTablesSettings
Methods
public DataTablesSettings AccessorForType<T>(String propertyName, Func<T, Object> accessor) #DataTablesSettingsType Parameters
- T
Parameters
- propertyName String
- accessor Func<T, Object>
AccessorForType``1(System.String propertyName, System.Func{``0,System.Object} accessor) #Registers a typed accessor for a property on type T. Used by JoinProperty and SmartLabel to read values without reflection.
Parameters
- propertyName System.String
- accessor System.Func{``0,System.Object}
public DataTablesSettings AccordionDefaults(Boolean responsiveInline = true) #DataTablesSettingsApplies recommended defaults when a table is rendered inside an accordion/collapse. Currently disables AutoWidth for smoother reveal behavior and allows Responsive to manage columns.
Parameters
- responsiveInline System.Boolean = true
- If true, also enables Responsive with inline details.
public DataTablesSettings AlphabetFilter(Int32 columnIndex = 0) #DataTablesSettingsAdds an A–Z alphabet filter toolbar that filters rows by the starting letter in the chosen column.
Parameters
- columnIndex System.Int32 = 0
ApplyTransformers() #Applies transformer and summarization settings to the underlying table. Invoked automatically when the Settings(...) block completes.
public DataTablesSettings BooleanFormatting(Action<DataTablesBooleanFormatterBuilder> configure) #DataTablesSettingsConfigures boolean value rendering (Yes/No, badges, or icons) for all boolean cells.
Parameters
- configure System.Action{HtmlForgeX.DataTablesBooleanFormatterBuilder}
public DataTablesSettings BytesFormatting(Action<DataTablesByteSizeFormatterBuilder> configure) #DataTablesSettingsFormats numeric byte counts for specific headers (e.g., "SizeBytes").
Parameters
- configure System.Action{HtmlForgeX.DataTablesByteSizeFormatterBuilder}
public DataTablesSettings CallbackEvalPolicy(DataTablesCallbackEvalPolicy policy) #DataTablesSettingsControls whether string callback fields (e.g., rowCallback) are revived into JS functions on the client. Default is Off. Prefer KnownSafeOnly in trusted scenarios.
Parameters
- policy HtmlForgeX.DataTablesCallbackEvalPolicy
public DataTablesSettings Callbacks(Action<DataTablesCallbacks> configure) #DataTablesSettingsSets DataTables callback functions via inline JS function bodies.
Parameters
- configure System.Action{HtmlForgeX.DataTablesCallbacks}
public DataTablesSettings ColumnFilters(DataTablesColumnFilterPlacement placement = Top) #DataTablesSettingsAdds per-column filter inputs and chooses where they are rendered.
Parameters
- placement HtmlForgeX.DataTablesColumnFilterPlacement = Top
public DataTablesSettings ConstrainToContainer(Boolean enable = true) #DataTablesSettingsWraps the table in a viewport div to confine horizontal overflow to the component. Enabled by default; disable only when embedding in custom scroll regions.
Parameters
- enable System.Boolean = true
public DataTablesSettings DateTimeFormatting(Action<DataTablesTemporalFormatterBuilder> configure) #DataTablesSettingsAlias for DataTablesTemporalFormatterBuilder>) for discoverability when searching for "DateTime".
Parameters
- configure System.Action{HtmlForgeX.DataTablesTemporalFormatterBuilder}
public DataTablesSettings DefaultOrder(Int32 columnIndex, String direction = "asc") #DataTablesSettingsSets the initial sort order for a column.
Parameters
- columnIndex System.Int32
- Zero-based column index.
- direction System.String = "asc"
- Sort direction: "asc" or "desc".
public DataTablesSettings DefaultOrder(params ValueTuple<Int32, String>[] orders) #DataTablesSettingsSets multiple default sort orders.
Parameters
- orders System.ValueTuple{System.Int32,System.String}[]
- Pairs of column index and direction.
public DataTablesSettings DetailBackground(DataTablesDetailBackgroundStyle style) #DataTablesSettingsControls the background treatment used for responsive child/detail rows.
Parameters
- style HtmlForgeX.DataTablesDetailBackgroundStyle
public DataTablesSettings DisableResponsive() #DataTablesSettingsDisables responsive display support.
public DataTablesSettings Dom(String dom) #DataTablesSettingsSets a raw DataTables DOM layout string (advanced). Prefer DataTablesDomPreset) when possible.
Parameters
- dom System.String
- DOM layout string, e.g., "Bfrtip".
public DataTablesSettings DomPreset(DataTablesDomPreset preset) #DataTablesSettingsApplies a friendly DOM layout preset instead of raw DOM strings.
Parameters
- preset HtmlForgeX.DataTablesDomPreset
public DataTablesSettings DurationFormatting(Action<DataTablesDurationFormatterBuilder> configure) #DataTablesSettingsFormats duration values (TimeSpan or strings like "5.3s", "4.1h") for specific headers. Adds data-order so sorting and exports use a stable numeric value.
Parameters
- configure System.Action{HtmlForgeX.DataTablesDurationFormatterBuilder}
public DataTablesSettings EmptyArraysAs(String placeholder) #DataTablesSettingsAlias for String).
Parameters
- placeholder System.String
public DataTablesSettings EmptyEnumerablesAs(String placeholder) #DataTablesSettingsDisplay a placeholder when enumerable properties are empty (instead of blank). Examples: "—", "N/A", "None". Pass null to revert to blank.
Parameters
- placeholder System.String
public DataTablesSettings EncodeCellValues(Boolean enable = true) #DataTablesSettingsHTML-encodes plain string cell values produced from objects/dictionaries. Disable only when table values intentionally contain trusted HTML markup.
Parameters
- enable System.Boolean = true
public DataTablesSettings EnumFormatting(Action<DataTablesEnumFormatterBuilder> configure) #DataTablesSettingsFormats enum values using [Description]/[Display(Name)] attributes or a PascalCase splitter.
Parameters
- configure System.Action{HtmlForgeX.DataTablesEnumFormatterBuilder}
public DataTablesSettings ExcludeProperties(params String[] propertyNames) #DataTablesSettingsExclude the specified properties/columns by name (case-insensitive).
Parameters
- propertyNames System.String[]
public DataTablesSettings ExpanderStyle(DataTablesExpanderStyle style) #DataTablesSettingsControls how responsive row expanders are rendered.
Parameters
- style HtmlForgeX.DataTablesExpanderStyle
public DataTablesSettings Export(Action<DataTablesExportBuilder> configure) #DataTablesSettingsEnables export buttons for the provided formats.
Parameters
- formats HtmlForgeX.DataTablesExportFormat[]
- Export formats to include.
Export(System.Action{HtmlForgeX.DataTablesExportBuilder} configure) #Configures export buttons using the fluent export builder.
Parameters
- configure System.Action{HtmlForgeX.DataTablesExportBuilder}
- Action to configure export buttons and options.
public DataTablesSettings ExportExcel(Action<DataTablesExcelExportBuilder> configure) #DataTablesSettingsConfigures Excel export via a typed builder that generates a safe customize(xlsx) function for the DataTables Buttons Excel export (e.g., sheet name, freeze header, column widths, number formats).
Parameters
- configure System.Action{HtmlForgeX.DataTablesExcelExportBuilder}
public DataTablesSettings ExportExcelCsvPdfCopyColumns() #DataTablesSettingsAdds common export buttons (Excel, CSV, PDF, Copy) and a column visibility menu with polished styling.
public DataTablesSettings ExportExcelCustomize(String jsFunction) #DataTablesSettingsAdds a raw JavaScript customize(...) function to the Excel button. Pass the full function body like: function(xlsx){ ... }.
Parameters
- jsFunction System.String
public DataTablesSettings ExportRawValues(Boolean enable = true) #DataTablesSettingsEnsures CSV/Excel/PDF exports use raw values from cells when available (reads data-raw attribute).
Parameters
- enable System.Boolean = true
public DataTablesSettings FixedColumns(Int32 left = 0, Int32 right = 0) #DataTablesSettingsFixes left and/or right columns in place when scrolling.
Parameters
- left System.Int32 = 0
- Number of columns to fix on the left.
- right System.Int32 = 0
- Number of columns to fix on the right.
public DataTablesSettings FixedHeader(Int32 headerOffset = 0, Boolean footer = false) #DataTablesSettingsEnables a fixed header with optional offset and footer support.
Parameters
- headerOffset System.Int32 = 0
- Offset in pixels for the fixed header.
- footer System.Boolean = false
- True to also fix the footer.
public DataTablesSettings Flatten(Action<DataTablesFlattenColumnsBuilder> configure) #DataTablesSettingsConfigure per-column enumerable formatting using a fluent helper. Example: s.Flatten(c => c.Named("Inventory").JoinProperty("ComputerName").Separator(", ").MaxItems(5));
Parameters
- configure System.Action{HtmlForgeX.DataTablesFlattenColumnsBuilder}
public DataTablesSettings FlattenEnumerables(DataTablesEnumerableFormat mode, String joinProperty = null, String separator = ", ", Nullable<Int32> maxItems = null) #DataTablesSettingsFlattens enumerable values (e.g., List, array) into strings for both HTML and JavaScript render modes.
Parameters
- mode HtmlForgeX.DataTablesEnumerableFormat
- Flattening strategy (Count, JoinToString, JoinProperty, Json).
- joinProperty System.String = null
- When using JoinProperty, the property name to take from each item.
- separator System.String = ", "
- Separator used for joins (default ", ").
- maxItems System.Nullable{System.Int32} = null
- Optional maximum items to show before appending an overflow indicator.
public DataTablesSettings FlattenProperty(String propertyName, DataTablesEnumerableFormat mode, String joinProperty = null, String separator = ", ", Nullable<Int32> maxItems = null) #DataTablesSettingsApplies a property-specific flattening rule for enumerable values.
Parameters
- propertyName System.String
- mode HtmlForgeX.DataTablesEnumerableFormat
- joinProperty System.String = null
- separator System.String = ", "
- maxItems System.Nullable{System.Int32} = null
public DataTablesSettings GeoGroup(String groupId) #DataTablesSettingsAssigns a selection group id for cross-component geo selection sync (Leaflet/Globe/VectorMap/DataTables). Use different values when multiple dashboards exist on the same page.
Parameters
- groupId System.String
public DataTablesSettings GeoLinkFromGlobe(GlobeGl globe, String keyColumnHeader, Action<DataTablesGeoLinkFromOptions> configure = null) #DataTablesSettingsLinks globe marker clicks back to the DataTables table by filtering the key column. Requires the globe marker to have a matching Key(...).
Parameters
- globeId System.String
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} = null
GeoLinkFromGlobe(HtmlForgeX.GlobeGl globe, System.String keyColumnHeader, System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} configure) #Links globe marker clicks back to the DataTables table by filtering the key column.
Parameters
- globe HtmlForgeX.GlobeGl
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions}
public DataTablesSettings GeoLinkFromLeafletMap(LeafletMap map, String keyColumnHeader, Action<DataTablesGeoLinkFromOptions> configure = null) #DataTablesSettingsLinks Leaflet marker clicks back to the DataTables table by filtering the key column. Requires the Leaflet marker to have a matching Key(...).
Parameters
- mapId System.String
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} = null
GeoLinkFromLeafletMap(HtmlForgeX.LeafletMap map, System.String keyColumnHeader, System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} configure) #Links Leaflet marker clicks back to the DataTables table by filtering the key column.
Parameters
- map HtmlForgeX.LeafletMap
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions}
public DataTablesSettings GeoLinkFromVectorMapMarkers(JsVectorMap map, String keyColumnHeader, Action<DataTablesGeoLinkFromOptions> configure = null) #DataTablesSettingsLinks jsVectorMap marker clicks back to the DataTables table by filtering the key column. Requires the vector map marker to have a matching Name (use String)).
Parameters
- mapId System.String
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} = null
GeoLinkFromVectorMapMarkers(HtmlForgeX.JsVectorMap map, System.String keyColumnHeader, System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} configure) #Links jsVectorMap marker clicks back to the DataTables table by filtering the key column.
Parameters
- map HtmlForgeX.JsVectorMap
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions}
public DataTablesSettings GeoLinkFromVectorMapRegions(JsVectorMap map, String keyColumnHeader, Action<DataTablesGeoLinkFromOptions> configure = null) #DataTablesSettingsLinks jsVectorMap region clicks back to the DataTables table by filtering the key column. Requires your table column to contain region codes matching the dataset (e.g., "US").
Parameters
- mapId System.String
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} = null
GeoLinkFromVectorMapRegions(HtmlForgeX.JsVectorMap map, System.String keyColumnHeader, System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions} configure) #Links jsVectorMap region clicks back to the DataTables table by filtering the key column.
Parameters
- map HtmlForgeX.JsVectorMap
- keyColumnHeader System.String
- configure System.Action{HtmlForgeX.DataTablesGeoLinkFromOptions}
public DataTablesSettings GeoLinkKeySeparator(String separator) #DataTablesSettingsWhen set, allows geo link key columns to contain multiple keys (e.g. "US West|EU Central|APAC"). The first key is focused and the remaining keys are highlighted (selection sync) when possible.
Parameters
- separator System.String
public DataTablesSettings GeoLinkToGlobe(GlobeGl globe, String keyColumnHeader, Double altitude = 1.2, Int32 ms = 900) #DataTablesSettingsLinks DataTables row clicks to a globe marker (by marker key) by moving the globe point-of-view. Requires the globe marker to have a matching Key(...).
Parameters
- globeId System.String
- keyColumnHeader System.String
- altitude System.Double = 1.2
- ms System.Int32 = 900
GeoLinkToGlobe(HtmlForgeX.GlobeGl globe, System.String keyColumnHeader, System.Double altitude, System.Int32 ms) #Links DataTables row clicks to a globe marker (by marker key).
Parameters
- globe HtmlForgeX.GlobeGl
- keyColumnHeader System.String
- altitude System.Double
- ms System.Int32
public DataTablesSettings GeoLinkToLeafletMap(LeafletMap map, String keyColumnHeader, Boolean openPopup = true, Nullable<Int32> zoom = null) #DataTablesSettingsLinks DataTables row clicks to a Leaflet map marker (by marker key). Requires the Leaflet marker to have a matching Key(...).
Parameters
- mapId System.String
- keyColumnHeader System.String
- openPopup System.Boolean = true
- zoom System.Nullable{System.Int32} = null
GeoLinkToLeafletMap(HtmlForgeX.LeafletMap map, System.String keyColumnHeader, System.Boolean openPopup, System.Nullable{System.Int32} zoom) #Links DataTables row clicks to a Leaflet map marker (by marker key).
Parameters
- map HtmlForgeX.LeafletMap
- keyColumnHeader System.String
- openPopup System.Boolean
- zoom System.Nullable{System.Int32}
public DataTablesSettings GeoLinkToVectorMapMarkers(JsVectorMap map, String keyColumnHeader) #DataTablesSettingsLinks DataTables row clicks to a jsVectorMap marker by marker name. Requires the vector map marker to have a matching Name (use String)).
Parameters
- mapId System.String
- keyColumnHeader System.String
GeoLinkToVectorMapMarkers(HtmlForgeX.JsVectorMap map, System.String keyColumnHeader) #Links DataTables row clicks to a jsVectorMap marker by marker name.
Parameters
- map HtmlForgeX.JsVectorMap
- keyColumnHeader System.String
public DataTablesSettings GeoLinkToVectorMapRegions(JsVectorMap map, String keyColumnHeader) #DataTablesSettingsLinks DataTables row clicks to a jsVectorMap region by region code (ISO). Requires your table column to contain region codes matching the dataset (e.g., "US").
Parameters
- mapId System.String
- keyColumnHeader System.String
GeoLinkToVectorMapRegions(HtmlForgeX.JsVectorMap map, System.String keyColumnHeader) #Links DataTables row clicks to a jsVectorMap region by region code (ISO).
Parameters
- map HtmlForgeX.JsVectorMap
- keyColumnHeader System.String
public DataTablesSettings HeaderFilters() #DataTablesSettingsAdds a header filter row with inputs for per-column searching.
public DataTablesSettings HeaderNaming(Action<DataTablesHeaderNamingOptions> configure) #DataTablesSettingsConfigure how property/header names are transformed into display labels. Supports acronyms (e.g., LAPS, DSRM, RBCD) and per-property overrides.
Parameters
- configure System.Action{HtmlForgeX.DataTablesHeaderNamingOptions}
public DataTablesSettings HideColumns(params String[] headerNames) #DataTablesSettingsHide columns entirely by header/property name. Columns remain in the data but are not visible.
Parameters
- headerNames System.String[]
public DataTablesSettings Html() #DataTablesSettingsEditorBrowsable(2)Convenience: render via HTML mode.
public DataTablesSettings IncludeProperties(params String[] propertyNames) #DataTablesSettingsInclude only the specified properties/columns by name (case-insensitive).
Parameters
- propertyNames System.String[]
public DataTablesSettings JavaScript() #DataTablesSettingsEditorBrowsable(2)Convenience: render via JavaScript mode.
public DataTablesSettings LabelerForProperty(String header, Func<Object, String> label) #DataTablesSettingsRegisters a labeler for a specific column header. When the table renders an enumerable column with this header, each item will be projected through the labeler instead of using reflection.
Parameters
- header System.String
- label System.Func{System.Object,System.String}
public DataTablesSettings LabelerForType<T>(Func<T, String> label) #DataTablesSettingsType Parameters
- T
Parameters
- label Func<T, String>
LabelerForType``1(System.Func{``0,System.String} label) #Registers a labeler used to derive display text for values of type T. This keeps display extraction AOT-safe and avoids reflection.
Parameters
- label System.Func{``0,System.String}
public DataTablesSettings Language(Action<DataTablesLanguage> configure) #DataTablesSettingsConfigures localization strings for this table.
Parameters
- configure System.Action{HtmlForgeX.DataTablesLanguage}
- Action to configure DataTablesLanguage.
public DataTablesSettings LazyInit(Boolean enable = true) #DataTablesSettingsDefers DataTables initialization until the table becomes visible (e.g., inside inactive tabs/accordions). Useful for large reports with many hidden tables to improve initial load performance.
Parameters
- enable System.Boolean = true
public DataTablesSettings LinkifyColumns(Action<DataTablesLinkifyBuilder> configure) #DataTablesSettingsLinkifies columns that contain URLs or email addresses. Applies per-header using a lightweight formatter.
Parameters
- configure System.Action{HtmlForgeX.DataTablesLinkifyBuilder}
public DataTablesSettings NullsAs(String placeholder) #DataTablesSettingsDisplays a placeholder for null values (default blank).
Parameters
- placeholder System.String
public DataTablesSettings NumberFormatting(Action<DataTablesNumberFormatterBuilder> configure) #DataTablesSettingsFormats numeric columns using .NET format strings (e.g., "N0", "P1"). Adds data-order/raw for correct sorting and export.
Parameters
- configure System.Action{HtmlForgeX.DataTablesNumberFormatterBuilder}
public DataTablesSettings ObjectSummary(Action<DataTablesObjectSummaryOptions> configure) #DataTablesSettingsConfigure how non-enumerable complex objects are summarized inside table cells. Enabled by default to avoid noisy CLR type names and provide compact key/value views.
Parameters
- configure System.Action{HtmlForgeX.DataTablesObjectSummaryOptions}
public DataTablesSettings Ordering(Boolean enable = true) #DataTablesSettingsEnables or disables column ordering.
Parameters
- enable System.Boolean = true
- True to allow ordering.
public DataTablesSettings PageLengthControl(DataTablesPageLengthPlacement placement = Top) #DataTablesSettingsControls where the native DataTables page-length selector is rendered when HtmlForgeX manages the layout.
Parameters
- placement HtmlForgeX.DataTablesPageLengthPlacement = Top
public DataTablesSettings PageLengthLabel(DataTablesPageLengthLabelMode mode = Default) #DataTablesSettingsControls how the native DataTables page-length selector is labeled.
Parameters
- mode HtmlForgeX.DataTablesPageLengthLabelMode = Default
public DataTablesSettings Paging(Int32 pageLength = 10, Int32[] lengthMenu = null) #DataTablesSettingsEnables paging and optionally configures page length and available sizes.
Parameters
- pageLength System.Int32 = 10
- Number of rows shown per page.
- lengthMenu System.Int32[] = null
- Optional collection of selectable page lengths.
public DataTablesSettings PagingControls(DataTablesPagingPlacement placement = Bottom) #DataTablesSettingsControls where native DataTables pagination buttons are rendered when HtmlForgeX manages the layout.
Parameters
- placement HtmlForgeX.DataTablesPagingPlacement = Bottom
public DataTablesSettings PagingType(DataTablesPagingType type) #DataTablesSettingsSets the paging UI style.
Parameters
- type HtmlForgeX.DataTablesPagingType
- Paging control type.
public DataTablesSettings PreferArrayRowsInJsRendering(Boolean enable = true) #DataTablesSettingsPrefer array rows (instead of object rows) when rendering via JavaScript to reduce per-row allocations. Note: if any ColumnHighlighter rule uses DataStore = "JavaScript", object rows are required; this method only applies when not required.
Parameters
- enable System.Boolean = true
public DataTablesSettings Preset(DataTablesPreset preset) #DataTablesSettingsApplies a pre-defined configuration preset.
Parameters
- preset HtmlForgeX.DataTablesPreset
public DataTablesSettings ProjectionForType<T>(Action<DataTablesProjectionBuilder<T>> build) #DataTablesSettingsType Parameters
- T
Parameters
- build Action<DataTablesProjectionBuilder<T>>
ProjectionForType``1(System.Action{HtmlForgeX.DataTablesProjectionBuilder{``0}} build) #Registers an ordered projection (list of named getters) used when summarizing complex objects of type T. Keeps object summaries rich in AOT without reflection.
Parameters
- build System.Action{HtmlForgeX.DataTablesProjectionBuilder{``0}}
public DataTablesSettings RelativeTimeFormatting(Action<DataTablesRelativeTimeFormatterBuilder> configure) #DataTablesSettingsFormats date/time or duration values as live-updating relative labels (uses hfx-relative-time).
Parameters
- configure System.Action{HtmlForgeX.DataTablesRelativeTimeFormatterBuilder}
public DataTablesSettings RenderMode(DataTablesRenderMode mode) #DataTablesSettingsSpecifies how the table should be rendered.
Parameters
- mode HtmlForgeX.DataTablesRenderMode
- Rendering mode.
public DataTablesSettings Responsive(Action<DataTablesResponsiveOptions> configure) #DataTablesSettingsEnables responsive display support.
Parameters
- enable System.Boolean = true
- True to enable responsive behaviour.
Responsive(HtmlForgeX.DataTablesDetailsMode mode) #Enables responsive display and selects how details are rendered.
Parameters
- mode HtmlForgeX.DataTablesDetailsMode
Responsive(System.Action{HtmlForgeX.DataTablesResponsiveOptions} configure) #Configures responsive behaviour with custom options.
Parameters
- configure System.Action{HtmlForgeX.DataTablesResponsiveOptions}
- Action to configure responsive options.
public DataTablesSettings ResponsiveHide(params String[] headerNames) #DataTablesSettingsPrefer these columns to hide first when Responsive is active (they appear in the details view).
Parameters
- headerNames System.String[]
public DataTablesSettings ResponsiveInline() #DataTablesSettingsEditorBrowsable(2)Convenience wrapper to enable Responsive with inline details mode.
public DataTablesSettings RowGroup(Nullable<Int32> columnIndex = null) #DataTablesSettingsGroups rows by the provided column index.
Parameters
- columnIndex System.Nullable{System.Int32} = null
- Column index to group by.
public DataTablesSettings RowGroup(Int32 columnIndex, Action<DataTablesRowGroup> configure) #DataTablesSettingsGroups rows by a column and applies additional row group configuration.
Parameters
- columnIndex System.Int32
- configure System.Action{HtmlForgeX.DataTablesRowGroup}
public DataTablesSettings RowGroupWithCount(Int32 columnIndex, String labelFormat = null) #DataTablesSettingsGroups rows by a column and shows a simple group header with the group label and row count.
Parameters
- columnIndex System.Int32
- Column index to group by.
- labelFormat System.String = null
- Optional format string. Use {group} and {count} placeholders.
public DataTablesSettings Scrolling(String scrollY = null, Boolean scrollX = false, Boolean scrollCollapse = false) #DataTablesSettingsConfigures scrolling behaviour for large tables.
Parameters
- scrollY System.String = null
- Height of the scrollable region.
- scrollX System.Boolean = false
- True to allow horizontal scrolling.
- scrollCollapse System.Boolean = false
- True to collapse empty space when scrolling.
public DataTablesSettings ScrollXOnly(Boolean scrollCollapse = true) #DataTablesSettingsSwitches the table to horizontal scroll mode only: disables Responsive and enables ScrollX. Good for legacy layouts; prefer Boolean) for most cases.
Parameters
- scrollCollapse System.Boolean = true
public DataTablesSettings SearchBuilder(Action<DataTablesSearchBuilder> configure = null) #DataTablesSettingsEnables search builder extension.
Parameters
- configure System.Action{HtmlForgeX.DataTablesSearchBuilder} = null
- Optional configuration callback.
public DataTablesSettings SearchDelay(Int32 milliseconds) #DataTablesSettingsAdds a delay (in milliseconds) before applying the global search term while typing. Maps to DataTables option searchDelay and can improve responsiveness on very large tables.
Parameters
- milliseconds System.Int32
public DataTablesSettings SearchHighlighting(Action<DataTablesSearchHighlighterConfig> configure) #DataTablesSettingsHighlights the active search terms directly inside cell text (HTMLExtensions plugin).
Parameters
- enable System.Boolean = true
SearchHighlighting(System.Action{HtmlForgeX.DataTablesSearchHighlighterConfig} configure) #Configures search-term highlighting (HTMLExtensions plugin).
Parameters
- configure System.Action{HtmlForgeX.DataTablesSearchHighlighterConfig}
public DataTablesSettings Searching(Boolean enable = true) #DataTablesSettingsToggles the global search box.
Parameters
- enable System.Boolean = true
- True to enable searching; otherwise false.
public DataTablesSettings SearchPanes(Action<DataTablesSearchPanes> configure = null) #DataTablesSettingsEnables search panes extension.
Parameters
- configure System.Action{HtmlForgeX.DataTablesSearchPanes} = null
- Optional configuration callback.
public DataTablesSettings Select(String style = "single") #DataTablesSettingsEnables row selection with the specified style.
Parameters
- style System.String = "single"
- Selection style such as "single" or "multi".
public DataTablesSettings ServerSide(Action<DataTablesAjax> configure) #DataTablesSettingsEnables server-side processing and configures Ajax.
Parameters
- configure System.Action{HtmlForgeX.DataTablesAjax}
public DataTablesSettings StateSave(Boolean enable = true, Nullable<Int32> durationSeconds = null) #DataTablesSettingsPersists table state such as paging and ordering.
Parameters
- enable System.Boolean = true
- True to save state.
- durationSeconds System.Nullable{System.Int32} = null
- Optional duration in seconds (-1 to persist indefinitely). If provided, sets DataTables stateDuration.
public DataTablesSettings Surface(TablerSurfaceStyle style) #DataTablesSettingsApplies a shared surface treatment to the table viewport shell.
Parameters
- style HtmlForgeX.TablerSurfaceStyle
public DataTablesSettings TableBackground(DataTablesTableBackgroundStyle style) #DataTablesSettingsControls how strongly the table body/background is surfaced inside the DataTables shell.
Parameters
- style HtmlForgeX.DataTablesTableBackgroundStyle
public DataTablesSettings TemporalFormatting(Action<DataTablesTemporalFormatterBuilder> configure) #DataTablesSettingsConfigures how DateTime/DateTimeOffset/TimeSpan values are rendered in table cells. Example: s.TemporalFormatting(t => t.UtcToLocal().DateTime("yyyy-MM-dd HH:mm").TimeSpanLargestUnit()).
Parameters
- configure System.Action{HtmlForgeX.DataTablesTemporalFormatterBuilder}
public DataTablesSettings ToggleViewButton(String text = "Switch View", ToggleViewMode defaultMode = Responsive, Boolean persist = true) #DataTablesSettingsAdds a built-in toggle button that switches between Responsive and ScrollX at runtime.
Parameters
- text System.String = "Switch View"
- defaultMode HtmlForgeX.ToggleViewMode = Responsive
- persist System.Boolean = true
public DataTablesSettings Toolbar(Action<DataTablesToolbarOptions> configure) #DataTablesSettingsConfigures the top toolbar layout (buttons + search alignment and order).
Parameters
- configure System.Action{HtmlForgeX.DataTablesToolbarOptions}
public DataTablesSettings TypeHintsByHeader(Action<DataTablesHeaderTypeHintsBuilder> configure) #DataTablesSettingsAssigns DataTables column types using header names (no index math required).
Parameters
- configure System.Action{HtmlForgeX.DataTablesHeaderTypeHintsBuilder}
Inherited Methods
Properties
public List<IValueTransformer> Transformers { get; } #Ordered list of value transformers applied to raw cell values before final formatting. Use to unwrap PSObjects or summarize complex values.
public Boolean SummarizeEnumerables { get; set; } #When true, non-string enumerable values are summarized according to EnumerableSummary.
public EnumerableSummaryMode EnumerableSummary { get; set; } #Summary strategy for enumerable values (Count, FirstN, JoinStrings).
public Int32 EnumerableFirstN { get; set; } #Number of items to include in FirstN mode.
public String EnumerableSeparator { get; set; } #Separator used when joining enumerable items.
public Int32 EnumerableMaxProbe { get; set; } #Upper bound on items probed when summarizing to avoid expensive enumeration.
public Boolean InlineEnumerableDetails { get; set; } #If true, appends a compact inline detail with the first N items under the summary text.
public Func<Object, IEnumerable<Object>> EnumerableDetailsProjector { get; set; } #Optional projector used to render inline details from an enumerable value (defaults to ToString of first N items).