Class
GridColumn

Defines a data bound column in the grid that can show all types of data.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class GridColumn : BoundColumnBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IGridBoundColumn, IColumn, IGridColumnMenuColumn, ITableColumnMenuColumn

Inheritance: objectComponentBaseColumnBaseBoundColumnBaseGridColumn

Implements: IColumnIComponentIDisposableIGridBoundColumnIGridColumnMenuColumnIHandleAfterRenderIHandleEventITableColumnMenuColumn

Inherited Members BoundColumnBase.OnParametersSet()BoundColumnBase.GetParsedFieldEditorType(Enum, bool)BoundColumnBase.FieldBoundColumnBase.FieldTypeBoundColumnBase.TitleBoundColumnBase.DisplayFormatBoundColumnBase.EditableBoundColumnBase.FilterableBoundColumnBase.SortableBoundColumnBase.ChildContentBoundColumnBase.TemplateBoundColumnBase.HeaderTemplateBoundColumnBase.FooterTemplateBoundColumnBase.EditorTemplateBoundColumnBase.TextAlignBoundColumnBase.FilterCellTemplateBoundColumnBase.FilterMenuTemplateBoundColumnBase.FilterMenuButtonsTemplateBoundColumnBase.FilterMenuTypeBoundColumnBase.ShowFilterCellButtonsBoundColumnBase.DefaultFilterOperatorBoundColumnBase.FilterOperatorsBoundColumnBase.FilterEditorFormatBoundColumnBase.VisibleInColumnChooserBoundColumnBase.LockableBoundColumnBase.ShowColumnMenuBoundColumnBase.ShowColumnChooserBoundColumnBase.PropertyTypeColumnBase.OnInitialized()ColumnBase.SetParametersAsync(ParameterView)ColumnBase.OnParametersSetAsync()ColumnBase.OnAfterRender(bool)ColumnBase.Dispose()ColumnBase.ParentColumnColumnBase.HeaderClassColumnBase.WidthColumnBase.MinResizableWidthColumnBase.MaxResizableWidthColumnBase.VisibleColumnBase.ReorderableColumnBase.ResizableColumnBase.LockedColumnBase.IdColumnBase.ColumnsCollectionComponentBase.OnInitializedAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)

Constructors

GridColumn()

Declaration

cs-api-definition
public GridColumn()

Properties

Columns

Contains child columns to create multi-level column headers for complex table structures and grouped column layouts. Children: GridColumn, GridCheckboxColumn, GridCommandColumn.

Declaration

cs-api-definition
[Parameter]
public RenderFragment Columns { get; set; }

Property Value

RenderFragment

EditorType

Specifies the input control type used for editing this column's data. Use TextBox for single-line text input, TextArea for multi-line text, DatePicker for date selection, TimePicker for time selection, DateTimePicker for combined date and time, Switch for on/off toggle, or CheckBox for boolean values. If not provided, a default editor will be used based on the field data type.

Declaration

cs-api-definition
[Parameter]
public GridEditorType? EditorType { get; set; }

Property Value

GridEditorType?

FilterEditorType

Specifies the input control type used for filtering this column's data. Use DatePicker to filter by date values only, or DateTimePicker to filter by both date and time values. If not provided, a default filter editor will be used based on the field data type.

Declaration

cs-api-definition
[Parameter]
public GridFilterEditorType? FilterEditorType { get; set; }

Property Value

GridFilterEditorType?

GroupFooterTemplate

Template displayed in the group footer row when data is grouped. Use this to show aggregated values like sum, count, or average for the group. You can render custom components and apply logic in it.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<GridGroupTemplateContext> GroupFooterTemplate { get; set; }

Property Value

RenderFragment<GridGroupTemplateContext>

Implements IGridBoundColumn.GroupFooterTemplate

GroupHeaderTemplate

Template displayed in the group header row when data is grouped by this column. Use this to customize how group headers appear with aggregates. The template is used when the Grid is grouped by the column. If no template is specified, the name of the Field and the current group value is displayed. You can render custom components and apply logic in it.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<GridGroupHeaderTemplateContext> GroupHeaderTemplate { get; set; }

Property Value

RenderFragment<GridGroupHeaderTemplateContext>

Implements IGridBoundColumn.GroupHeaderTemplate

Groupable

Enables users to group data by this column when grouping is enabled. Set to false to prevent grouping by this specific column.

Declaration

cs-api-definition
[Parameter]
public bool Groupable { get; set; }

Property Value

bool

Implements IGridBoundColumn.Groupable

OnCellRender

Fires every time a cell in this column is rendered. Use this to conditionally apply custom CSS classes or styling based on cell value.

Declaration

cs-api-definition
[Parameter]
public Action<GridCellRenderEventArgs> OnCellRender { get; set; }

Property Value

Action<GridCellRenderEventArgs>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

ThrowIfInvalidEditorType()

Declaration

cs-api-definition
protected override void ThrowIfInvalidEditorType()

Overrides BoundColumnBase.ThrowIfInvalidEditorType()

ThrowIfInvalidFilterEditorType()

Declaration

cs-api-definition
protected override void ThrowIfInvalidFilterEditorType()

Overrides BoundColumnBase.ThrowIfInvalidFilterEditorType()