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

GanttBuilder

Defines the fluent API for configuring the Kendo Gantt for ASP.NET MVC.

Methods

DataSource(System.Action)

Configures the DataSource options.

Parameters

configurator - System.Action<GanttDataSourceBuilder>

The DataSource configurator action.

Example


             @(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
                .Name("Gantt")
                .DataSource(source =>
                {
                    source.Read(read =>
                    {
                        read.Action("Read", "Gantt");
                    });
                })
            )

DataSource(System.String)

Parameters

dataSourceId - System.String

DependenciesDataSource(System.Action)

Configures the dependencies DataSource options.

Parameters

configurator - System.Action<GanttDependenciesDataSourceBuilder>

The DataSource configurator action.

Example


            @(Html.Kendo().Gantt<TaskViewModel, DependencyViewModel>()
                .Name("Gantt")
                .DependenciesDataSource(source =>
                {
                    source.Read(read =>
                    {
                        read.Action("Read", "Gantt");
                    });
                })
             )

DependenciesDataSource(System.String)

Parameters

dataSourceId - System.String

Columns(System.Action)

The configuration of the gantt columns. An array of JavaScript objects or strings. A JavaScript objects are interpreted as column configurations. Strings are interpreted as the field to which the column is bound. The gantt will create a column for every item of the array.

Parameters

configurator - System.Action<GanttColumnFactory>

The action that configures the columns.

Assignments(System.Action)

The configuration of the assignments of the gantt resources. An assignment is a one-to-one mapping between a gantt task and a gantt resource containing the number of units for which a resource is assigned to a task.

Parameters

configurator - System.Action<GanttAssignmentsSettingsBuilder>

The action that configures the assignments.

CurrentTimeMarker(System.Action)

If set to false the "current time" marker of the Gantt would not be displayed.

Parameters

configurator - System.Action<GanttCurrentTimeMarkerSettingsBuilder>

The action that configures the currenttimemarker.

Editable()

If set to false the user won't be able to create, modify or delete tasks and dependencies.

Resources(System.Action)

The configuration of the gantt resource(s). A gantt resource is optional metadata that can be associated with a gantt task.

Parameters

configurator - System.Action<GanttResourcesSettingsBuilder>

The action that configures the resources.

AutoBind(System.Boolean)

If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.

Parameters

value - System.Boolean

The value that configures the autobind.

ColumnResizeHandleWidth(System.Double)

Defines the width of the column resize handle in pixels. Apply a larger value for easier grasping.

Parameters

value - System.Double

The value that configures the columnresizehandlewidth.

ColumnMenu(System.Boolean)

If set to true, the Gantt displays the column menu when the user clicks the Chevron icon in the column headers. The column menu allows the user to show and hide columns, and, if filtering and sorting are enabled, filter and sort the data. By default, the column menu is disabled. Can be set to a JavaScript object which represents the column menu configuration.

Parameters

value - System.Boolean

The value that configures the columnmenu.

Date(System.DateTime)

If set to some date and it is between the range start and range end of the selected view, the timeline of the currently selected view is scrolled to start from this date.

Parameters

value - System.DateTime

The value that configures the date.

Editable(System.Boolean)

If set to false the user won't be able to create, modify or delete tasks and dependencies.

Parameters

enabled - System.Boolean

Enables or disables the editable option.

Editable(System.Action)

If set to false the user won't be able to create, modify or delete tasks and dependencies.

Parameters

configurator - System.Action<GanttEditableSettingsBuilder>

The action that configures the editable.

Filterable(System.Boolean)

If set to true, the user can filter the data source by using the Gantt filter menu. By default, filtering is disabled. Can be set to a JavaScript object which represents the filter menu configuration.

Parameters

value - System.Boolean

The value that configures the filterable.

Reorderable(System.Boolean)

If set to true, the user can reorder the columns in the GanttList section of the widget by dragging their header cells. By default, reordering is disabled.

Parameters

value - System.Boolean

The value that configures the reorderable.

If set to true the user could navigate the widget using the keyboard. By default keyboard navigation is disabled.

Parameters

value - System.Boolean

The value that configures the navigatable.

WorkDayStart(System.DateTime)

Sets the start of the work day.

Parameters

value - System.DateTime

The value that configures the workdaystart.

WorkDayEnd(System.DateTime)

Sets the end of the work day.

Parameters

value - System.DateTime

The value that configures the workdayend.

WorkWeekStart(System.Double)

The start of working week (index based).

Parameters

value - System.Double

The value that configures the workweekstart.

WorkWeekEnd(System.Double)

The end of working week (index based).

Parameters

value - System.Double

The value that configures the workweekend.

HourSpan(System.Double)

The span of an hour slot.

Parameters

value - System.Double

The value that configures the hourspan.

Snap(System.Boolean)

If set to true the Gantt will snap tasks to the nearest slot during dragging (resizing or moving). Set it to false to allow free moving and resizing of tasks.

Parameters

value - System.Boolean

The value that configures the snap.

Height(System.Double)

The height of the widget. Numeric values are treated as pixels.

Parameters

value - System.Double

The value that configures the height.

ListWidth(System.String)

The width of the task list. Numeric values are treated as pixels.

Parameters

value - System.String

The value that configures the listwidth.

Messages(System.Action)

The configuration of the Gantt messages. Use this option to customize or localize the Gantt messages.

Parameters

configurator - System.Action<GanttMessagesSettingsBuilder>

The action that configures the messages.

Pdf(System.Action)

Configures the Kendo UI Gantt PDF export settings.

Parameters

configurator - System.Action<GanttPdfSettingsBuilder>

The action that configures the pdf.

Range(System.Action)

Configures the Kendo UI Gantt range settings.

Parameters

configurator - System.Action<GanttRangeSettingsBuilder>

The action that configures the range.

Resizable(System.Boolean)

If set to true allows users to resize columns by dragging their header borders. By default resizing is disabled.

Parameters

value - System.Boolean

The value that configures the resizable.

Selectable(System.Boolean)

If set to false the user won't be able to select tasks in the Gantt. By default selection is enabled and triggers the change event.

Parameters

value - System.Boolean

The value that configures the selectable.

ShowPlannedTasks(System.Boolean)

If set to true, the Gantt Timeline will render both the planned and the actual execution of tasks. In order to display properly, the Planned vs. Actual view would need the plannedStart and plannedEnd date fields for tasks to be set.

Parameters

value - System.Boolean

The value that configures the showplannedtasks.

ShowWorkDays(System.Boolean)

If set to false, Gantt views will show all days of the week. By default the views display only business days.

Parameters

value - System.Boolean

The value that configures the showworkdays.

ShowWorkHours(System.Boolean)

If set to false, the day view will show all hours of the day. By default the view displays only business hours.

Parameters

value - System.Boolean

The value that configures the showworkhours.

TaskTemplate(System.String)

The template used to render the gantt tasks.The fields which can be used in the template are the task fields

Parameters

value - System.String

The value that configures the tasktemplate.

TaskTemplateId(System.String)

The template used to render the gantt tasks.The fields which can be used in the template are the task fields

Parameters

value - System.String

The value that configures the tasktemplate.

Toolbar(System.Action)

If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole Gantt Toolbar, and the string value will be passed as an argument to a kendo.template() function.If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the Gantt Toolbar contents.If an Array value is assigned, it will be treated as the list of commands displayed in the Gantt Toolbar. Commands can be custom or built-in ("append", "pdf", "plannedTasks").The "append" command adds a new task to the gantt.The "pdf" command exports the gantt in PDF format.The "plannedTasks" command will render the plannedTasks Switch on the Toolbar. That Switch allows the user to turn on and off the Planned vs. Actual view in the Timeline of the Gantt. When turned on, that view will render both the planned and the actual duration of all tasks. When enabled, plannedStart and plannedEnd date fields of tasks are required to properly render planned duration.

Parameters

configurator - System.Action<GanttToolbarFactory>

The action that configures the toolbar.

Tooltip(System.Action)

The task tooltip configuration options.

Parameters

configurator - System.Action<GanttTooltipSettingsBuilder>

The action that configures the tooltip.

Views(System.Action)

The views displayed by the Gantt and their configuration. The array items can be either objects specifying the view configuration or strings representing the view types (assuming default configuration). By default the Kendo UI Gantt widget displays "day", "week", and "month" views.

Parameters

configurator - System.Action<GanttViewFactory>

The action that configures the views.

RowHeight(System.Double)

The height of the table rows. Numeric values are treated as pixels.

Parameters

value - System.Double

The value that configures the rowheight.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<GanttEventBuilder>

The client events action.

Example


            @(Html.Kendo().Gantt()
                .Name("Gantt")
                .Events(events => events
                    .DataBinding("onDataBinding")
                )
            )

ToComponent()

Returns the internal view component.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name of the component.

Example


            @(Html.Kendo().Grid<OrderViewModel>()
               .Name("grid")
               .Columns(columns =>
               {
                   columns.Bound(p => p.OrderID).Filterable(false);
                   columns.Bound(p => p.Freight);  
               })
               .DataSource(dataSource => dataSource
                   .Ajax()
                   .PageSize(20)
                   .Read(read => read.Action("Orders_Read", "Grid"))
               )
            )

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean)

Parameters

deferred - System.Boolean

ModelMetadata(System.Web.Mvc.ModelMetadata)

Uses the Metadata of the Model.

Parameters

modelMetadata - System.Web.Mvc.ModelMetadata

The metadata set for the Model

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

Render()

Renders the component.

Example


            @(@Page Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" )
            @( Html.Kendo().Grid(Model)
                .Name("grid")
                .DetailTemplate(product => {
                    )
                       Product Details:
                       <div>Product Name: @( product.ProductName )</div>
                       <div>Units In Stock: @( product.UnitsInStock )</div>
                    @(
                })
                .Render();
            )

ToHtmlString()

ToClientTemplate()

In this article
Not finding the help you need?