GridColumnBase<T>
The base class for all columns in Kendo Grid for ASP.NET MVC.
Definition
Namespace:Kendo.Mvc.UI
Assembly:Kendo.Mvc.dll
Type Parameters:
T
Syntax:
public abstract class GridColumnBase<T> : JsonObject, IGridColumn where T : classInheritance: objectJsonObjectGridColumnBase<T>
Derived Classes:
Implements:
Inherited Members
Constructors
Properties
The template which renders the footer table cell for the column. The fields which can be used in the template are: Average - the value of the "average" aggregate (if specified) Count - the value of the "count" aggregate (if specified) Max - the value of the "max" aggregate (if specified) Min - the value of the "min" aggregate (if specified) Sum - the value of the "sum" aggregate (if specified) Data - provides access to all available aggregates
public string ClientFooterTemplate { get; set; }Implements:
public string ClientFooterTemplateHandler { get; set; }Implements:
The template which renders the group footer for the corresponding column. By default the group footer is not displayed. The group footer will always appear as long as at least one column has a defined groupFooterTemplate. The fields which can be used in the template are:
average - the value of the "average" aggregate (if specified)
count - the value of the "count" aggregate (if specified)
max - the value of the "max" aggregate (if specified)
min - the value of the "min" aggregate (if specified)
sum - the value of the "sum" aggregate (if specified)
data - provides access to all available aggregates, e.g. data.fieldName1.sum or data.fieldName2.average
group - provides information for the current group. An object with three fields - field, value and items. items field contains the data items for current group. Returns groups if the data items are grouped (in case there are child groups) ///public string ClientGroupFooterTemplate { get; set; }Implements:
public string ClientGroupFooterTemplateHandler { get; set; }Implements:
The template which renders the column content. The grid renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) which represent the grid columns. By default the HTML-encoded value of the field is displayed in the column.
public string ClientTemplate { get; set; }Implements:
public string ClientTemplateHandler { get; set; }Implements:
If set to false the column menu will not be rendered for the specific column.
public virtual bool ColumnMenu { get; set; }Implements:
If set to true a draghandle will be rendered and the user could reorder the rows by dragging the row via the drag handle. If the selectable option is enabled for rows only selected rows will can be dragged and reordered.
public virtual bool Draggable { get; set; }Implements:
Html editor.
public string EditorHtml { get; set; }If set to true the column value will be HTML-encoded before it is displayed. If set to false the column value will be displayed as is. By default the column value is HTML-encoded.
public virtual bool Encoded { get; set; }Implements:
Specifying the column should be exported and the export settings.
public GridColumnExportableSettings Exportable { get; set; }Implements:
Gets the footer HTML attributes.
public IDictionary<string, object> FooterHtmlAttributes { get; }The footer HTML attributes.
Implements:
Gets the footer template of the column.
public HtmlTemplate<GridAggregateResult> FooterTemplate { get; set; }Implements:
Gets the header HTML attributes.
public IDictionary<string, object> HeaderHtmlAttributes { get; }The header HTML attributes.
Implements:
Gets/Sets the header template of the column.
public HtmlTemplate HeaderTemplate { get; set; }Implements:
Gets or sets a value indicating whether this column is hidden.
public virtual bool Hidden { get; set; }true if hidden; otherwise, false.
Implements:
Hidden columns are output as HTML but are not visible by the end-user.
Gets the HTML attributes of the cell rendered for the column
public IDictionary<string, object> HtmlAttributes { get; }The HTML attributes.
Implements:
The html attributes handler.
public string HtmlAttributesHandler { get; set; }The handler name.
Implements:
If set to true the column will be visible in the grid column menu. By default the column menu includes all data-bound columns (ones that have their field set).
public virtual bool IncludeInMenu { get; set; }Implements:
The function that generates the inline template.
public virtual Func<T, object> InlineTemplate { get; set; }Returns 'true' if the column is last and 'false' if it's not.
public bool IsLast { get; }Implements:
If set to false the column will remain in the side of the grid into which its own locked configuration placed it.
public virtual bool Lockable { get; set; }Implements:
If set to true the column will be displayed as locked (frozen) in the grid.
public virtual bool Locked { get; set; }Implements:
Sets the condition that needs to be satisfied for a column to remain visible.
public string Media { get; set; }Implements:
Gets the member of the column.
public string Member { get; set; }The member.
The pixel screen width below which the user will not be able to resize the column via the UI.
public int MinResizableWidth { get; set; }Implements:
The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting, so the two should not be used at the same time.
public int MinScreenWidth { get; set; }Implements:
If set to false the column will become non-resizable, while all the other columns remaining resizable in the grid component. In order for this property to work, grid's resizable property must be set to true
public virtual bool Resizable { get; set; }Implements:
public bool ShouldEncodeFooterHtmlAttributes { get; set; }Implements:
public bool ShouldEncodeHeaderHtmlAttributes { get; set; }Implements:
public bool ShouldEncodeHtmlAttributes { get; set; }Implements:
If set to true the user will be able to stick or unstick the column from the column menu.
public virtual bool Stickable { get; set; }Implements:
If set to true the column will be displayed as sticky in the grid.
public virtual bool Sticky { get; set; }Implements:
Gets the template of the column.
public virtual Action<T> Template { get; set; }Gets or sets the title of the column.
public virtual string Title { get; set; }The title.
Implements:
Gets or sets a value indicating whether this column is visible.
public virtual bool Visible { get; set; }true if visible; otherwise, false. The default value is true.
Implements:
Invisible columns are not output in the HTML.
Methods
Creates the Display Builder.
public virtual IGridDataCellBuilder CreateDisplayBuilder(IGridHtmlHelper htmlHelper)Implements:
protected virtual IGridDataCellBuilder CreateDisplayBuilderCore(IGridHtmlHelper htmlHelper)Creates the Edit Builder.
public IGridDataCellBuilder CreateEditBuilder(IGridHtmlHelper htmlHelper)Implements:
protected abstract IGridDataCellBuilder CreateEditBuilderCore(IGridHtmlHelper htmlHelper)Creates the Footer Builder.
public IGridCellBuilder CreateFooterBuilder(IEnumerable<AggregateResult> aggregateResults)Implements:
protected virtual IGridCellBuilder CreateFooterBuilderCore(IEnumerable<AggregateResult> aggregateResults)Creates the Group Footer Builder.
public IGridCellBuilder CreateGroupFooterBuilder(IEnumerable<AggregateResult> aggregatesResults)Implements:
protected virtual IGridCellBuilder CreateGroupFooterBuilderCore(IEnumerable<AggregateResult> aggregateResults)Creates the Header column Builder.
public virtual IGridCellBuilder CreateGroupHeaderColumnBuilder(IEnumerable<AggregateResult> aggregatesResults)Implements:
Creates the Header Builder.
Creates the Insert Builder.
public IGridDataCellBuilder CreateInsertBuilder(IGridHtmlHelper htmlHelper)Implements:
protected abstract IGridDataCellBuilder CreateInsertBuilderCore(IGridHtmlHelper htmlHelper)protected void Decorate(IGridDecoratableCellBuilder cellBuilder)protected override void Serialize(IDictionary<string, object> json)Overrides: