HtmlForgeX

API Reference

Class

DataTablesTemporalFormatterBuilder

Fluent helper to configure temporal value formatting for DataTablesTable. Produces and attaches a TemporalValueTransformer.

Inheritance

  • Object
  • DataTablesTemporalFormatterBuilder

Methods

public DataTablesTemporalFormatterBuilder DateOnly(String format) #
Returns: DataTablesTemporalFormatterBuilder

Sets the Date-only format string used when time is midnight (default: yyyy-MM-dd).

Parameters

format System.String requiredposition: 0
public DataTablesTemporalFormatterBuilder DateTime(String format) #
Returns: DataTablesTemporalFormatterBuilder

Sets the DateTime format string (default: yyyy-MM-dd HH:mm).

Parameters

format System.String requiredposition: 0
public DataTablesTemporalFormatterBuilder DateTimeOffset(String format) #
Returns: DataTablesTemporalFormatterBuilder

Sets the DateTimeOffset format string. When not set, uses the DateTime format.

Parameters

format System.String requiredposition: 0
public DataTablesTemporalFormatterBuilder RelativeDates(Boolean enable = true, Boolean tooltip = true) #
Returns: DataTablesTemporalFormatterBuilder

Show relative dates (e.g., "3 days ago") with an optional tooltip containing the absolute time.

Parameters

enable System.Boolean = true optionalposition: 0
tooltip System.Boolean = true optionalposition: 1
public DataTablesTemporalFormatterBuilder TimeSpanConstant() #
Returns: DataTablesTemporalFormatterBuilder

Formats TimeSpan using the built-in constant/"c" form (e.g., 1.00:00:00).

public DataTablesTemporalFormatterBuilder TimeSpanCustom(String format) #
Returns: DataTablesTemporalFormatterBuilder

Formats TimeSpan with a custom format string (e.g., "dd\\:hh\\:mm").

Parameters

format System.String requiredposition: 0
public DataTablesTemporalFormatterBuilder TimeSpanLargestUnit() #
Returns: DataTablesTemporalFormatterBuilder

Formats TimeSpan using the largest unit (e.g., "15 days").

public DataTablesTemporalFormatterBuilder TimeSpanShort() #
Returns: DataTablesTemporalFormatterBuilder

Formats TimeSpan using a concise form like "15d 4h 3m".

public DataTablesTemporalFormatterBuilder UtcToLocal(Boolean enable = true) #
Returns: DataTablesTemporalFormatterBuilder

Convert UTC DateTime/DateTimeOffset to local time before formatting.

Parameters

enable System.Boolean = true optionalposition: 0