Class BoundColumnBase

Inheritance
System.Object
ColumnBase
BoundColumnBase
GanttColumn
GridColumn
TreeListColumn
Inherited Members
Namespace: Telerik.Blazor.Components.Common
Assembly: Telerik.Blazor.dll

Syntax

public abstract class BoundColumnBase : ColumnBase, IDisposable, IBoundColumn, IColumn

Constructors

BoundColumnBase()

Declaration
protected BoundColumnBase()

Properties

ChildContent

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

DefaultFilterOperator

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

Declaration
public Nullable<FilterOperator> DefaultFilterOperator { get; set; }
Property Value
System.Nullable<FilterOperator>

DisplayFormat

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

Declaration
public string DisplayFormat { get; set; }
Property Value
System.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
public bool Editable { get; set; }
Property Value
System.Boolean

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
public RenderFragment<object> EditorTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

Field

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

Declaration
public string Field { get; set; }
Property Value
System.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
public Type FieldType { get; set; }
Property Value
System.Type

Filterable

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

Declaration
public bool Filterable { get; set; }
Property Value
System.Boolean

FilterCellTemplate

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

Declaration
public RenderFragment<FilterCellTemplateContext> FilterCellTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<FilterCellTemplateContext>

FilterEditorFormat

Specifies the format of the filter editor.

Declaration
public string FilterEditorFormat { get; set; }
Property Value
System.String

FilterMenuButtonsTemplate

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

Declaration
public RenderFragment<FilterMenuTemplateContext> FilterMenuButtonsTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<FilterMenuTemplateContext>

FilterMenuTemplate

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

Declaration
public RenderFragment<FilterMenuTemplateContext> FilterMenuTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<FilterMenuTemplateContext>

FilterMenuType

Specifies the filter menu type.

Declaration
public Nullable<FilterMenuType> FilterMenuType { get; set; }
Property Value
System.Nullable<Telerik.Blazor.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
public List<FilterListOperator> FilterOperators { get; set; }
Property Value
System.Collections.Generic.List<FilterListOperator>

FooterTemplate

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

Declaration
public RenderFragment<FooterTemplateContext> FooterTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.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
public RenderFragment HeaderTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

Lockable

Specifies if the column can be locked from the UI.

Declaration
public bool Lockable { get; set; }
Property Value
System.Boolean

PropertyType

Declaration
protected Type PropertyType { get; }
Property Value
System.Type

ShowColumnChooser

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

Declaration
public bool ShowColumnChooser { get; set; }
Property Value
System.Boolean

ShowColumnMenu

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

Declaration
public bool ShowColumnMenu { get; set; }
Property Value
System.Boolean

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
public bool ShowFilterCellButtons { get; set; }
Property Value
System.Boolean

Sortable

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

Declaration
public bool Sortable { get; set; }
Property Value
System.Boolean

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
public RenderFragment<object> Template { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

TextAlign

Specifies the text alignemnt of the column.

Declaration
public Nullable<ColumnTextAlign> TextAlign { get; set; }
Property Value
System.Nullable<ColumnTextAlign>

Title

The string title rendered in the column header.

Declaration
public override string Title { get; set; }
Property Value
System.String

Overrides
Implements

VisibleInColumnChooser

Specifies if the column is visible in the column chooser.

Declaration
public bool VisibleInColumnChooser { get; set; }
Property Value
System.Boolean

Methods

GetParsedFieldEditorType(Enum, Boolean)

Declaration
protected Nullable<FieldEditorType> GetParsedFieldEditorType(Enum editorType, bool isFilterField = false)
Parameters
System.Enum editorType

System.Boolean isFilterField

Returns
System.Nullable<Telerik.Blazor.FieldEditorType>

OnParametersSet()

Declaration
protected override void OnParametersSet()

ThrowIfInvalidEditorType()

Declaration
protected abstract void ThrowIfInvalidEditorType()

ThrowIfInvalidFilterEditorType()

Declaration
protected abstract void ThrowIfInvalidFilterEditorType()