Class
BoundColumnBase

Definition

Namespace:Telerik.Blazor.Components.Common

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public abstract class BoundColumnBase : ColumnBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IColumn

Inheritance: objectComponentBaseColumnBaseBoundColumnBase

Derived Classes: GanttColumnGridColumnTreeListColumn

Implements: IColumnIComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ColumnBase.OnInitialized()ColumnBase.SetParametersAsync(ParameterView)ColumnBase.OnParametersSetAsync()ColumnBase.OnAfterRender(bool)ColumnBase.Dispose()ColumnBase.ParentColumnColumnBase.HeaderClassColumnBase.WidthColumnBase.MinResizableWidthColumnBase.MaxResizableWidthColumnBase.VisibleColumnBase.ReorderableColumnBase.ResizableColumnBase.LockedColumnBase.IdColumnBase.ColumnsCollectionComponentBase.BuildRenderTree(RenderTreeBuilder)ComponentBase.OnInitializedAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

BoundColumnBase()

Declaration

cs-api-definition
protected BoundColumnBase()

Properties

ChildContent

Declaration

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

Property Value

RenderFragment

DefaultFilterOperator

Specifies the default filter operator. If unassigned, the default operator will be set based on the data type. See FilterOperator.

Declaration

cs-api-definition
[Parameter]
public FilterOperator? DefaultFilterOperator { get; set; }

Property Value

FilterOperator?

DisplayFormat

The format that will be used to represent Numeric or DateTime values.

Declaration

cs-api-definition
[Parameter]
public string DisplayFormat { get; set; }

Property Value

string

Editable

Whether the field can be edited by the user. If set to false, an editor will not be rendered for this column when the user edits an existing record.

Declaration

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

Property Value

bool

EditorTemplate

The template rendered in the cell when the user is editing the row. You can render custom components and apply logic in it.

Declaration

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

Property Value

RenderFragment<object>

Field

The name of the field whose data the grid will display. You can use the nameof operator.

Declaration

cs-api-definition
[Parameter]
public string Field { get; set; }

Property Value

string

FieldType

The type of the field whose data the grid will display. You need to pass this parameter only if you are using ExpandoObject or Dictionary.

Declaration

cs-api-definition
[Parameter]
public Type FieldType { get; set; }

Property Value

Type

FilterCellTemplate

The template rendered in the cell when a filter row is used.

Declaration

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

Property Value

RenderFragment<FilterCellTemplateContext>

FilterEditorFormat

Specifies the format of the filter editor.

Declaration

cs-api-definition
[Parameter]
public string FilterEditorFormat { get; set; }

Property Value

string

FilterMenuButtonsTemplate

The buttons template rendered in the popup when a filter menu is used.

Declaration

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

Property Value

RenderFragment<FilterMenuTemplateContext>

FilterMenuTemplate

The form template rendered in the popup when a filter menu is used.

Declaration

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

Property Value

RenderFragment<FilterMenuTemplateContext>

FilterMenuType

Specifies the filter menu type.

Declaration

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

Property Value

FilterMenuType?

FilterOperators

Specifies the available filter operators. If not defined, a default list of available operators will be used based on the field type. See FilterListOperator.

Declaration

cs-api-definition
[Parameter]
public List<FilterListOperator> FilterOperators { get; set; }

Property Value

List<FilterListOperator>

Filterable

Whether the user can filter this column. When set to false, the filter cell will remain empty.

Declaration

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

Property Value

bool

FooterTemplate

The template for the footer cell of this column. You can render custom components and apply logic in it.

Declaration

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

Property Value

RenderFragment<FooterTemplateContext>

HeaderTemplate

The template for the header cell of this column. When the template is used, the Title text is not rendered by default. You can render custom components and apply logic in it.

Declaration

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

Property Value

RenderFragment

Lockable

Specifies if the column can be locked from the UI.

Declaration

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

Property Value

bool

PropertyType

Declaration

cs-api-definition
protected Type PropertyType { get; }

Property Value

Type

ShowColumnChooser

Specifies if the column chooser is displayed in the column menu.

Declaration

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

Property Value

bool

ShowColumnMenu

Specifies if a column menu should be shown for the column.

Declaration

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

Property Value

bool

ShowFilterCellButtons

Specifies whether the buttons within the filter cell are rendered or not. Default value is true. Applicable when FilterMode is set to FilterRow.

Declaration

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

Property Value

bool

Sortable

Specifies whether the column can be sorted. Field is required.

Declaration

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

Property Value

bool

Template

The template for the cells of this column. Used when the row is in read mode. You can render custom components and apply logic in it.

Declaration

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

Property Value

RenderFragment<object>

TextAlign

Specifies the text alignemnt of the column.

Declaration

cs-api-definition
[Parameter]
public ColumnTextAlign? TextAlign { get; set; }

Property Value

ColumnTextAlign?

Title

The string title rendered in the column header.

Declaration

cs-api-definition
[Parameter]
public override string Title { get; set; }

Property Value

string

Overrides ColumnBase.Title

Implements IColumn.Title

VisibleInColumnChooser

Specifies if the column is visible in the column chooser.

Declaration

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

Property Value

bool

Methods

GetParsedFieldEditorType(Enum, bool)

Declaration

cs-api-definition
protected FieldEditorType? GetParsedFieldEditorType(Enum editorType, bool isFilterField = false)

Parameters

editorType

Enum

isFilterField

bool

Returns

FieldEditorType?

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

ThrowIfInvalidEditorType()

Declaration

cs-api-definition
protected abstract void ThrowIfInvalidEditorType()

ThrowIfInvalidFilterEditorType()

Declaration

cs-api-definition
protected abstract void ThrowIfInvalidFilterEditorType()