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

SchedulerYearViewBuilder<TView>

Class

Defines the fluent interface for configuring the SchedulerYearView.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TView

Syntax:

public class SchedulerYearViewBuilder<TView> : SchedulerBaseViewBuilder<TView, SchedulerYearViewBuilder<TView>> where TView : SchedulerYearView

Inheritance: objectSchedulerBaseViewBuilder<TView, SchedulerYearViewBuilder<TView>>SchedulerYearViewBuilder<TView>

Constructors

SchedulerYearViewBuilder(TView)

public SchedulerYearViewBuilder(TView resource)

Parameters:resourceTView

Methods

Months(double?)

The number of months that will be displayed in the year view calendar.

public SchedulerYearViewBuilder<TView> Months(double? months)

Parameters:monthsdouble?

The number of months

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Messages(m =&gt; m.Views(v =&gt; v.Agenda("AgendaMessage")))
.Views(views =&gt;
{
views.YearView(w =&gt; w.Months(3));
})
)

StartDate(DateTime)

The start date of the view.

public SchedulerYearViewBuilder<TView> StartDate(DateTime startDate)

Parameters:startDateDateTime

The startDate

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Messages(m =&gt; m.Views(v =&gt; v.Agenda("AgendaMessage")))
.Views(views =&gt;
{
views.YearView(w =&gt; w.StartDate(DateTime.Now));
})
)

TooltipTemplate(string)

Defines the template used to render the tooltip in Year view. The available fields in the template are:

date: The selected date from the calendar.
events: The list of events and their respective resource for the selected date.
messages: The configuration of the Scheduler messages used for localization.

public SchedulerYearViewBuilder<TView> TooltipTemplate(string tooltipTemplate)

Parameters:tooltipTemplatestring

The value that configures the template content.

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Views(views =&gt;
{
views.YearView(w =&gt; w.TooltipTemplate("#= kendo.toString(date, 'dd-MM-yyyy')#"));
})
)

TooltipTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template used to render the tooltip in Year view. The available fields in the template are:

date: The selected date from the calendar.
events: The list of events and their respective resource for the selected date.
messages: The configuration of the Scheduler messages used for localization.

public SchedulerYearViewBuilder<TView> TooltipTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Views(views =&gt;
{
views.YearView(w =&gt; w.TooltipTemplate(Html.Kendo().Template().AddHtml("${kendo.toString(data.date, 'dd-MM-yyyy')}")));
})
)

TooltipTemplateHandler(string)

Defines the template used to render the tooltip in Year view. The available fields in the template are:

date: The selected date from the calendar.
events: The list of events and their respective resource for the selected date.
messages: The configuration of the Scheduler messages used for localization.

public SchedulerYearViewBuilder<TView> TooltipTemplateHandler(string tooltipTemplate)

Parameters:tooltipTemplatestring

The JavaScript function that returns the template.

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Views(views =&gt;
{
views.YearView(w =&gt; w.TooltipTemplateHandler("getTooltipTemplate"));
})
)
&lt;script&gt;
function getTooltipTemplate(data) {
return `${kendo.toString(data.date, 'dd-MM-yyyy')}`;
}
&lt;/script&gt;

TooltipTemplateId(string)

Defines the template used to render the tooltip in Year view. The available fields in the template are:

date: The selected date from the calendar.
events: The list of events and their respective resource for the selected date.
messages: The configuration of the Scheduler messages used for localization.

public SchedulerYearViewBuilder<TView> TooltipTemplateId(string tooltipTemplateId)

Parameters:tooltipTemplateIdstring

The "id" attribute of the external Kendo UI Template.

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Views(views =&gt; views.YearView(w =&gt; w.TooltipTemplateId("tooltipTemplate")))
)
&lt;script id="tooltipTemplate" type="text/x-kendo-template"&gt;
#= kendo.toString(date, 'dd-MM-yyyy')#
&lt;/script&gt;

TooltipTemplateView(MvcHtmlString)

Defines the template used to render the tooltip in Year view. The available fields in the template are:

date: The selected date from the calendar.
events: The list of events and their respective resource for the selected date.
messages: The configuration of the Scheduler messages used for localization.

public SchedulerYearViewBuilder<TView> TooltipTemplateView(MvcHtmlString tooltipTemplate)

Parameters:tooltipTemplateMvcHtmlString

The Razor View that contains the template.

Returns:

SchedulerYearViewBuilder<TView>

Example:

@(Html.Kendo().Scheduler&lt;Activity&gt;()
.Name("scheduler")
.Views(views =&gt;
{
views.YearView(w =&gt; w.TooltipTemplateView(Html.Partial("TooltipTemplate")));
})
)