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>)

Constructors

GridColumn()

Declaration

cs-api-definition
public GridColumn()

Properties

Columns

The list of child columns to produce multi-column headers.

Declaration

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

Property Value

RenderFragment

EditorType

Defines the editor used for editing for the given field. 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

Defines the editor used for filtering for the given field. If not provided, a default editor will be used based on the field data type.

Declaration

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

Property Value

GridFilterEditorType?

GroupFooterTemplate

Represents the column group footer cell template, where you can access and print out column aggregate values. 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

Represents the column group header template, where you can access and print out column aggregate values. 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

Specifies if the grid can be grouped by this column.

Declaration

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

Property Value

bool

Implements IGridBoundColumn.Groupable

OnCellRender

Called each time a cell is rendered. Use this to add custom classes to the cell based on its 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()