HtmlForgeX

API Reference

Class

DataTablesFlattenColumnRule

Namespace HtmlForgeX
Assembly HtmlForgeX

Fluent rule for one column's enumerable formatting.

Inheritance

  • Object
  • DataTablesFlattenColumnRule

Methods

Apply(HtmlForgeX.DataTablesTable arg1) #

Apply this rule to the root table.

Parameters

arg1 HtmlForgeX.DataTablesTable required
public DataTablesFlattenColumnRule Count() #
Returns: DataTablesFlattenColumnRule

Renders the number of items instead of joining values.

Returns

The current rule instance.

public DataTablesFlattenColumnRule JoinProperty(String property) #
Returns: DataTablesFlattenColumnRule

Flattens complex objects by extracting the specified property.

Parameters

property System.String requiredposition: 0
Property to extract from each item.

Returns

The current rule instance.

public DataTablesFlattenColumnRule JoinToString(String separator = ", ") #
Returns: DataTablesFlattenColumnRule

Joins item ToString values using the provided separator.

Parameters

separator System.String = ", " optionalposition: 0
Separator to use between values.

Returns

The current rule instance.

public DataTablesFlattenColumnRule Json() #
Returns: DataTablesFlattenColumnRule

Serializes the enumerable to JSON.

Returns

The current rule instance.

public DataTablesFlattenColumnRule MaxItems(Int32 max) #
Returns: DataTablesFlattenColumnRule

Limits how many items are rendered before truncation.

Parameters

max System.Int32 requiredposition: 0
Maximum number of items.

Returns

The current rule instance.

public DataTablesFlattenColumnRule Mode(DataTablesEnumerableFormat mode) #
Returns: DataTablesFlattenColumnRule

Sets the flattening mode explicitly.

Parameters

mode HtmlForgeX.DataTablesEnumerableFormat requiredposition: 0
Flattening mode to apply.

Returns

The current rule instance.

public DataTablesFlattenColumnRule Separator(String separator) #
Returns: DataTablesFlattenColumnRule

Overrides the separator used when joining values.

Parameters

separator System.String requiredposition: 0
Separator to use.

Returns

The current rule instance.