Class BOBDataColumn<TItem>

Namespace

BlazOrbit.Components

Assembly

BlazOrbit.dll

public class BOBDataColumn<TItem> : ComponentBase

Type Parameters

TItem

Inheritance

object

ComponentBase

BOBDataColumn<TItem>

Constructors

BOBDataColumn()

public BOBDataColumn()

Properties

Aggregate

Aggregate function rendered in the column footer (Sum, Avg, …). Default None.

[Parameter]
public AggregateFunction Aggregate { get; set; }

Property Value

AggregateFunction

AggregateFormat

Format string applied to the aggregate value. Falls back to Format when null.

[Parameter]
public string? AggregateFormat { get; set; }

Property Value

string

AggregateLabel

Optional prefix label shown next to the aggregate (e.g. "Total: ").

[Parameter]
public string? AggregateLabel { get; set; }

Property Value

string

Align

Align.

[Parameter]
public ColumnAlign Align { get; set; }

Property Value

ColumnAlign

CellClass

CSS class applied to the Cell.

[Parameter]
public string? CellClass { get; set; }

Property Value

string

CustomAggregate

Custom aggregate. Invoked when Aggregate is Custom.

[Parameter]
public Func<IEnumerable<TItem>, object?>? CustomAggregate { get; set; }

Property Value

Func<IEnumerable<TItem>, object>

CustomComparer

Custom sort comparer for the column. Replaces default value comparison when Sortable is on.

[Parameter]
public Func<TItem, TItem, int>? CustomComparer { get; set; }

Property Value

Func<TItem, TItem, int>

CustomFilter

Custom filter predicate. Replaces default substring matching when Filterable is on.

[Parameter]
public Func<TItem, string, bool>? CustomFilter { get; set; }

Property Value

Func<TItem, string, bool>

EditTemplate

Optional editor render fragment used in place of the auto-resolved input primitive while a cell is in edit mode. Receives the row item — bind to its properties via the consumer-supplied template.

[Parameter]
public RenderFragment<TItem>? EditTemplate { get; set; }

Property Value

RenderFragment<TItem>

Editable

When true and the parent grid runs in an inline-edit mode, this column participates in editing. Requires Property to bind to a writable member (auto-derived setter) or an explicit EditTemplate.

[Parameter]
public bool Editable { get; set; }

Property Value

bool

FilterMode

Filter category. Drives which input type + operator dropdown render when ShowColumnFilters=true on the parent grid. Defaults to Text. Use Numeric for =/!=/>/< against numeric properties, or Date for Before / After / Equals against date properties.

[Parameter]
public ColumnFilterMode FilterMode { get; set; }

Property Value

ColumnFilterMode

Filterable

Filterable.

[Parameter]
public bool Filterable { get; set; }

Property Value

bool

Format

Format.

[Parameter]
public string? Format { get; set; }

Property Value

string

Freeze

Pin side. Start sticks the column to the inline-start edge of the scroll container, End to the inline-end. Frozen columns require an explicit pixel Width so the grid can compute cumulative offsets for adjacent frozen peers.

[Parameter]
public ColumnFreeze Freeze { get; set; }

Property Value

ColumnFreeze

Header

Header.

[Parameter]
public string? Header { get; set; }

Property Value

string

HeaderClass

CSS class applied to the Header.

[Parameter]
public string? HeaderClass { get; set; }

Property Value

string

HeaderTemplate

Custom template for rendering the Header.

[Parameter]
public RenderFragment? HeaderTemplate { get; set; }

Property Value

RenderFragment

MaxWidth

Upper bound (in pixels) the resize drag clamps to. 0 = no limit.

[Parameter]
public double MaxWidth { get; set; }

Property Value

double

MinWidth

Lower bound (in pixels) the resize drag clamps to. Default 48.

[Parameter]
public double MinWidth { get; set; }

Property Value

double

Property

Expression that selects the column's bound property. Used to derive header text, sorting, and filtering.

[Parameter]
public Expression<Func<TItem, object?>>? Property { get; set; }

Property Value

Expression<Func<TItem, object>>

Resizable

When true, the grid renders a drag handle on the trailing edge of this column's header so the user can resize via pointer events. Requires BOBDataGrid.Resizable to be on.

[Parameter]
public bool Resizable { get; set; }

Property Value

bool

Sortable

Sortable.

[Parameter]
public bool Sortable { get; set; }

Property Value

bool

Template

Custom template for rendering the .

[Parameter]
public RenderFragment<TItem>? Template { get; set; }

Property Value

RenderFragment<TItem>

Validator

Optional validator invoked on every cell commit when Editable is on. Receives the row item and the proposed value; returns the error message to surface in the cell's tooltip when invalid, or null to allow the commit.

[Parameter]
public Func<TItem, object?, string?>? Validator { get; set; }

Property Value

Func<TItem, object, string>

Visible

Visible.

[Parameter]
public bool Visible { get; set; }

Property Value

bool

Width

Width.

[Parameter]
public string? Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

protected override void OnParametersSet()