GanttColumnBuilder
Methods
Format(System.String)
Gets or sets the format for displaying the data.
Parameters
value - System.String
The value.
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@( Html.Kendo().Gantt(Model)
.Name("Gantt")
.Columns(columns => columns.Bound(o => o.OrderDate).Format("{0:dd/MM/yyyy}"))
)
HeaderTemplate(System.String)
The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.
Parameters
value - System.String
The value for HeaderTemplate
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).HeaderTemplate("Value");
})
)
HeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.
Parameters
template - TemplateBuilder<Object>
The content of the column.
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title)
.HeaderTemplate(Html.Kendo().Template()
.AddHtml("<div class='my-custom-cell'>${data.Title}</div>")
);
})
)
HeaderTemplateId(System.String)
The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.
Parameters
templateId - System.String
The ID of the template element for HeaderTemplate
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).HeaderTemplateId("Value");
})
)
HeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The the view that contains the template element for HeaderTemplate
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).HeaderTemplateView(Html.Partial("TemplateView"))
})
)
HeaderTemplateHandler(System.String)
The template which renders the custom content of the Header.
Parameters
templateHandler - System.String
The value that configures the template.
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).HeaderTemplateHandler("templateHandler");
})
)
Width(System.Double)
The width of the column. Numeric values are treated as pixels.
Parameters
value - System.Double
The value for Width
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@( Html.Kendo().Gantt(Model)
.Name("Gantt")
.Columns(columns => columns.Bound(o => o.OrderID).Width(100))
)
Sortable(System.Action)
Sortable configuration
Parameters
configurator - System.Action<GanttColumnSortableSettingsBuilder>
The action that configures the sortable.
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).Sortable(s => s.Compare("compareHandler"));
})
)
Sortable()
Sortable configuration
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).Sortable(s => s.Compare("compareHandler"));
})
)
Sortable(System.Boolean)
If set to true the user could sort this column by clicking its header cells. By default sorting is disabled.
Parameters
value - System.Boolean
Determines whether sorting will be enabled or not.
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).Sortable(true);
})
)
Template(System.String)
The template which renders the column content. The Gantt renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) which represent the GanttList columns. By default, the HTML-encoded value of the field is displayed in the column.
Parameters
value - System.String
The value for Template
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).Template("Value");
})
)
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the column content. The Gantt renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) which represent the GanttList columns. By default, the HTML-encoded value of the field is displayed in the column.
Parameters
template - TemplateBuilder<Object>
The value for the Template
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title)
.Template(Html.Kendo().Template()
.AddHtml("<div class='my-custom-cell'>${data.Title}</div>")
);
})
)
TemplateId(System.String)
The template which renders the column content. The Gantt renders table rows (<tr>) which represent the data source items. Each table row consists of table cells (<td>) which represent the GanttList columns. By default, the HTML-encoded value of the field is displayed in the column.
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
A GanttColumnBuilder instance that can be used to configure the Gantt column.
Example
@(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
.Name("gantt")
.Columns(columns =>
{
columns.Bound(c => c.Title).TemplateId("Value");
})
)
HtmlAttributes(System.Collections.Generic.IDictionary)
The HTML attributes of the table cell (<td>) that is rendered for the column.
Parameters
value - System.Collections.Generic.IDictionary<String,Object>
The value for HtmlAttributes
RETURNS
Returns the current GanttColumnBuilder instance.
HtmlAttributes(System.Object)
The HTML attributes of the table cell (<td>) that is rendered for the column.
Parameters
value - System.Object
The value for HtmlAttributes
RETURNS
Returns the current GanttColumnBuilder instance.
Editable(System.Boolean)
Specifies whether this column can be edited by the user.
Parameters
value - System.Boolean
The value for Editable
RETURNS
Returns the current GanttColumnBuilder instance.
Editable()
Specifies whether this column can be edited by the user.
RETURNS
Returns the current GanttColumnBuilder instance.
Expandable(System.Boolean)
If set to true, the column will show the icons that are used for expanding and collapsing child rows. By default, the "title" column of the Gantt is expandable.
Parameters
value - System.Boolean
The value for Expandable
RETURNS
Returns the current GanttColumnBuilder instance.
Expandable()
If set to true, the column will show the icons that are used for expanding and collapsing child rows. By default, the "title" column of the Gantt is expandable.
RETURNS
Returns the current GanttColumnBuilder instance.
Field(System.String)
The field to which the column is bound. The value of this field is displayed by the column during data binding.The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.
Parameters
value - System.String
The value for Field
RETURNS
Returns the current GanttColumnBuilder instance.
Filterable(System.Action)
If set to true and if filtering is enabled for the entire Gantt, a filter menu will be displayed for this column. If set to false, the filter menu will not be displayed. By default, a filter menu is displayed for all columns when filtering is enabled through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration.
Parameters
configurator - System.Action<GanttColumnFilterableSettingsBuilder>
The configurator for the filterable setting.
RETURNS
Returns the current instance of GanttColumnBuilder .
Filterable(System.Boolean)
If set to true and if filtering is enabled for the entire Gantt, a filter menu will be displayed for this column. If set to false, the filter menu will not be displayed. By default, a filter menu is displayed for all columns when filtering is enabled through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration.
Parameters
enabled - System.Boolean
Enables or disables the filterable option.
RETURNS
Returns the current instance of GanttColumnFilterableSettingsBuilder .
HeaderAttributes(System.Collections.Generic.IDictionary)
The HTML attributes of the table header cell (<th>) that is rendered for the column.
Parameters
value - System.Collections.Generic.IDictionary<String,Object>
The value for HeaderAttributes
RETURNS
Returns the current GanttColumnBuilder instance.
HeaderAttributes(System.Object)
The HTML attributes of the table header cell (<th>) that is rendered for the column.
Parameters
value - System.Object
The value for HeaderAttributes
RETURNS
Returns the current GanttColumnBuilder instance.
Hidden(System.Boolean)
If set to true, the Gantt will not display the column. By default, all columns are displayed.
Parameters
value - System.Boolean
The value for Hidden
RETURNS
Returns the current GanttColumnBuilder instance.
Hidden()
If set to true, the Gantt will not display the column. By default, all columns are displayed.
RETURNS
Returns the current GanttColumnBuilder instance.
Menu(System.Boolean)
If set to true, the Gantt will display the column in the column menu. By default, the column menu includes all data-bound columns, that is, the ones with a set field option.
Parameters
value - System.Boolean
The value for Menu
RETURNS
Returns the current GanttColumnBuilder instance.
MinScreenWidth(System.Double)
The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting and the two cannot not be used at the same time.
Parameters
value - System.Double
The value for MinScreenWidth
RETURNS
Returns the current GanttColumnBuilder instance.
Title(System.String)
The text that is displayed in the column header cell. If not set the field is used.
Parameters
value - System.String
The value for Title
RETURNS
Returns the current GanttColumnBuilder instance.
Width(System.String)
The width of the column. Numeric values are treated as pixels.
Parameters
value - System.String
The value for Width
RETURNS
Returns the current GanttColumnBuilder instance.