HtmlForgeX

API Reference

Class

DataTablesRelativeTimeFormatterBuilder

Fluent helper to render relative times that update on the client (uses hfx-relative-time). Supports DateTime/DateTimeOffset values or duration strings like "5.3s", "4.1h".

Inheritance

  • Object
  • DataTablesRelativeTimeFormatterBuilder

Methods

public DataTablesRelativeTimeFormatterBuilder AsBadge(TablerBadgeStyle style = Soft, Nullable<TablerColor> textColor = null) #
Returns: DataTablesRelativeTimeFormatterBuilder

Render the relative time as a badge.

Parameters

style HtmlForgeX.TablerBadgeStyle = Soft optionalposition: 0
textColor System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 1
public DataTablesRelativeTimeFormatterBuilder Configure(Action<TablerRelativeTime> configure) #
Returns: DataTablesRelativeTimeFormatterBuilder

Applies additional configuration to each TablerRelativeTime instance.

Parameters

configure System.Action{HtmlForgeX.TablerRelativeTime} requiredposition: 0
public DataTablesRelativeTimeFormatterBuilder For(params String[] headers) #
Returns: DataTablesRelativeTimeFormatterBuilder

Applies formatting to the specified headers (case-insensitive).

Parameters

headers System.String[] requiredposition: 0
public DataTablesRelativeTimeFormatterBuilder Mode(TablerRelativeTimeDisplayMode mode) #
Returns: DataTablesRelativeTimeFormatterBuilder

Sets the display mode (relative only, absolute only, or mixed).

Parameters

mode HtmlForgeX.TablerRelativeTimeDisplayMode requiredposition: 0
public DataTablesRelativeTimeFormatterBuilder RawNumeric(Boolean enable = true) #
Returns: DataTablesRelativeTimeFormatterBuilder

Use numeric raw values (ms) for data-raw exports.

Parameters

enable System.Boolean = true optionalposition: 0
public DataTablesRelativeTimeFormatterBuilder RelativeStyle(TablerRelativeTimeRelativeStyle style) #
Returns: DataTablesRelativeTimeFormatterBuilder

Sets the relative time display style (full or compact).

Parameters

style HtmlForgeX.TablerRelativeTimeRelativeStyle requiredposition: 0
public DataTablesRelativeTimeFormatterBuilder TooltipAbsolute(Boolean enable = true) #
Returns: DataTablesRelativeTimeFormatterBuilder

Enable or disable absolute-time tooltip.

Parameters

enable System.Boolean = true optionalposition: 0
public DataTablesRelativeTimeFormatterBuilder UpdateEvery(Nullable<TimeSpan> interval) #
Returns: DataTablesRelativeTimeFormatterBuilder

Sets how often the relative label updates on the client.

Parameters

interval System.Nullable{System.TimeSpan} requiredposition: 0