New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Type Parameters:

TModel

TValue

Syntax:

C#
public class GridBoundColumn<TModel, TValue> : GridColumnBase<TModel>, IGridBoundColumn, IGridTemplateColumn<TModel>, IGridColumn where TModel : class

Inheritance: objectJsonObjectGridColumnBase<TModel>GridBoundColumn<TModel, TValue>

Derived Classes: GridForeignKeyColumn<TModel, TValue>

Implements: IGridBoundColumnIGridColumnIGridTemplateColumn<TModel>

Inherited Members GridColumnBase<TModel>.Decorate(IGridDecoratableCellBuilder)GridColumnBase<TModel>.CreateDisplayBuilder(IGridHtmlHelper)GridColumnBase<TModel>.CreateEditBuilder(IGridHtmlHelper)GridColumnBase<TModel>.CreateInsertBuilder(IGridHtmlHelper)GridColumnBase<TModel>.CreateHeaderBuilder()GridColumnBase<TModel>.CreateFooterBuilder(IEnumerable<AggregateResult>)GridColumnBase<TModel>.CreateGroupFooterBuilder(IEnumerable<AggregateResult>)GridColumnBase<TModel>.AppendHeaderContent(IHtmlNode)GridColumnBase<TModel>.FormatGridColumnBase<TModel>.EditorHtmlGridColumnBase<TModel>.GridGridColumnBase<TModel>.MemberGridColumnBase<TModel>.TemplateGridColumnBase<TModel>.ExportableGridColumnBase<TModel>.ShouldEncodeHtmlAttributesGridColumnBase<TModel>.ShouldEncodeFooterHtmlAttributesGridColumnBase<TModel>.ShouldEncodeHeaderHtmlAttributesGridColumnBase<TModel>.HeaderTemplateGridColumnBase<TModel>.FooterTemplateGridColumnBase<TModel>.InlineTemplateGridColumnBase<TModel>.TitleGridColumnBase<TModel>.WidthGridColumnBase<TModel>.MediaGridColumnBase<TModel>.MinScreenWidthGridColumnBase<TModel>.MinResizableWidthGridColumnBase<TModel>.ClientTemplateGridColumnBase<TModel>.ClientTemplateHandlerGridColumnBase<TModel>.ClientFooterTemplateGridColumnBase<TModel>.ClientFooterTemplateHandlerGridColumnBase<TModel>.ClientGroupFooterTemplateGridColumnBase<TModel>.ClientGroupFooterTemplateHandlerGridColumnBase<TModel>.HiddenGridColumnBase<TModel>.DraggableGridColumnBase<TModel>.IncludeInMenuGridColumnBase<TModel>.LockedGridColumnBase<TModel>.LockableGridColumnBase<TModel>.StickyGridColumnBase<TModel>.StickableGridColumnBase<TModel>.ColumnMenuGridColumnBase<TModel>.EncodedGridColumnBase<TModel>.ResizableGridColumnBase<TModel>.HeaderHtmlAttributesGridColumnBase<TModel>.FooterHtmlAttributesGridColumnBase<TModel>.VisibleGridColumnBase<TModel>.HtmlAttributesGridColumnBase<TModel>.HtmlAttributesHandlerGridColumnBase<TModel>.IsLastJsonObject.ToJson()object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

Initializes a new instance of the GridBoundColumn<TModel, TValue> class.

C#
public GridBoundColumn(Grid<TModel> grid, Expression<Func<TModel, TValue>> expression)
Parameters:gridGrid<TModel>expressionExpression<Func<TModel, TValue>>

Properties

Gets or sets the additional view data.

C#
public object AdditionalViewData { get; set; }

Implements: IGridBoundColumn.AdditionalViewData

Holds the value of the Client group header column template.

C#
public string ClientGroupHeaderColumnTemplate { get; set; }

Implements: IGridBoundColumn.ClientGroupHeaderColumnTemplate

C#
public string ClientGroupHeaderColumnTemplateHandler { get; set; }

Holds the value of the Client group header template.

C#
public string ClientGroupHeaderTemplate { get; set; }

Implements: IGridBoundColumn.ClientGroupHeaderTemplate

C#
public string ClientGroupHeaderTemplateHandler { get; set; }

Implements: IGridBoundColumn.ClientGroupHeaderTemplateHandler

The aggregate(s) which are calculated when the grid is grouped by the columns field. The supported aggregates are "average", "count", "max", "min" and "sum". Use this setting to set the column aggregates when using an external DataSource.

C#
public string[] ColumnAggregates { get; set; }

Implements: IGridBoundColumn.ColumnAggregates

Specify if the column is editable.

C#
public ClientHandlerDescriptor Editable { get; set; }

Implements: IGridBoundColumn.Editable

Gets or sets the name of the Editor Template.

C#
public string EditorTemplateName { get; set; }

Implements: IGridBoundColumn.EditorTemplateName

Expression

Expression<Func<TModel, TValue>>

C#
public Expression<Func<TModel, TValue>> Expression { get; }

Gets or sets a value indicating whether this GridColumnBase<T> is filterable.

C#
public bool Filterable { get; set; }
Property Value:

true if filterable; otherwise, false. The default value is true.

Implements: IGridBoundColumn.Filterable

The filter setting.

C#
public GridBoundColumnFilterableSettings FilterableSettings { get; set; }

Implements: IGridBoundColumn.FilterableSettings

Gets or sets a value indicating whether this column is groupable.

C#
public bool Groupable { get; set; }
Property Value:

true if groupable; otherwise, false.

Implements: IGridBoundColumn.Groupable

Gets or sets the groupable settings.

C#
public GridBoundColumnGroupableSettings GroupableSettings { get; set; }

Implements: IGridBoundColumn.GroupableSettings

Holds the value of the group footer template.

C#
public HtmlTemplate<GridAggregateResult> GroupFooterTemplate { get; }

Implements: IGridBoundColumn.GroupFooterTemplate

Holds the value of the group header column template.

C#
public HtmlTemplate<GridAggregateResult> GroupHeaderColumnTemplate { get; }

Implements: IGridBoundColumn.GroupHeaderColumnTemplate

Holds the value of the group header template.

C#
public HtmlTemplate<GridGroupAggregateResult> GroupHeaderTemplate { get; }

Implements: IGridBoundColumn.GroupHeaderTemplate

C#
public bool HasHandlerEditor { get; set; }

Implements: IGridBoundColumn.HasHandlerEditor

If set to true the column will be hidden when the grid is groupd via user interaction. The column will be displayed again if interaction to ungroup by it is performed.

C#
public bool HideOnGroup { get; set; }

Implements: IGridBoundColumn.HideOnGroup

Gets type of the property to which the column is bound to.

C#
public Type MemberType { get; set; }

Implements: IGridBoundColumn.MemberType

Metadata

ModelMetadata

Gets or sets metadata of the model.

C#
public ModelMetadata Metadata { get; }

Gets or sets a value indicating whether this GridColumnBase<T> is sortable.

C#
public bool Sortable { get; set; }
Property Value:

true if sortable; otherwise, false. The default value is true.

Implements: IGridBoundColumn.Sortable

The sort setting.

C#
public GridBoundColumnSortableSettings SortableSettings { get; set; }

Implements: IGridBoundColumn.SortableSettings

C#
public ListSortDirection? SortDirection { get; }

Implements: IGridBoundColumn.SortDirection

C#
public int SortIndex { get; }

Value

Func<TModel, TValue>

Gets a function which returns the value of the property to which the column is bound to.

C#
public Func<TModel, TValue> Value { get; }

Methods

C#
protected override IGridDataCellBuilder CreateDisplayBuilderCore(IGridHtmlHelper htmlHelper)
Parameters:htmlHelperIGridHtmlHelperReturns:

IGridDataCellBuilder

Overrides: GridColumnBase<TModel>.CreateDisplayBuilderCore(IGridHtmlHelper)

C#
protected override IGridDataCellBuilder CreateEditBuilderCore(IGridHtmlHelper htmlHelper)
Parameters:htmlHelperIGridHtmlHelperReturns:

IGridDataCellBuilder

Overrides: GridColumnBase<TModel>.CreateEditBuilderCore(IGridHtmlHelper)

C#
protected override IGridCellBuilder CreateFooterBuilderCore(IEnumerable<AggregateResult> aggregateResults)
Parameters:aggregateResultsIEnumerable<AggregateResult>Returns:

IGridCellBuilder

Overrides: GridColumnBase<TModel>.CreateFooterBuilderCore(IEnumerable<AggregateResult>)

C#
protected override IGridCellBuilder CreateGroupFooterBuilderCore(IEnumerable<AggregateResult> aggregateResults)
Parameters:aggregateResultsIEnumerable<AggregateResult>Returns:

IGridCellBuilder

Overrides: GridColumnBase<TModel>.CreateGroupFooterBuilderCore(IEnumerable<AggregateResult>)

Creates the Header column Builder.

C#
public override IGridCellBuilder CreateGroupHeaderColumnBuilder(IEnumerable<AggregateResult> aggregatesResults)
Parameters:aggregatesResultsIEnumerable<AggregateResult>Returns:

IGridCellBuilder

Overrides: GridColumnBase<TModel>.CreateGroupHeaderColumnBuilder(IEnumerable<AggregateResult>)

Implements: IGridColumn.CreateGroupHeaderColumnBuilder(IEnumerable<AggregateResult>)

C#
protected override IGridCellBuilder CreateHeaderBuilderCore()
Returns:

IGridCellBuilder

Overrides: GridColumnBase<TModel>.CreateHeaderBuilderCore()

C#
protected override IGridDataCellBuilder CreateInsertBuilderCore(IGridHtmlHelper htmlHelper)
Parameters:htmlHelperIGridHtmlHelperReturns:

IGridDataCellBuilder

Overrides: GridColumnBase<TModel>.CreateInsertBuilderCore(IGridHtmlHelper)

C#
public string GetEditor()
Returns:

string

Implements: IGridBoundColumn.GetEditor()

C#
public string GetSortUrl()
Returns:

string

C#
protected override void Serialize(IDictionary<string, object> json)
Parameters:jsonIDictionary<string, object>

Overrides: GridColumnBase<TModel>.Serialize(IDictionary<string, object>)