# SchedulerYearViewBuilder

## Methods

### StartDate(System.DateTime)

The start date of the view.

#### Parameters

##### startDate - `System.DateTime`

The startDate

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### Months(System.Nullable)

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

#### Parameters

##### months - `System.Nullable<Double>`

The number of months

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### TooltipTemplate(System.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.

#### Parameters

##### tooltipTemplate - `System.String`

The value that configures the template content.

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### TooltipTemplateId(System.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.

#### Parameters

##### tooltipTemplateId - `System.String`

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

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### TooltipTemplateHandler(System.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.

#### Parameters

##### tooltipTemplateHandler - `System.String`

The JavaScript function that returns the template.

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### TooltipTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

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.

#### Parameters

##### tooltipTemplateView - `Microsoft.AspNetCore.Html.IHtmlContent`

The Razor View that contains the template.

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

```
 
                   @(Html.Kendo().Scheduler<Activity>()
                        .Name("scheduler")
                        .Views(views =>
                        {
                            views.YearView(w => w.TooltipTemplateView(Html.Partial("TooltipTemplate")));
                        })
                   )
             
```

### TooltipTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

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.

#### Parameters

##### template - TemplateBuilder\<TModel>

A Template component that configures the template.

#### RETURNS

Returns the current [SchedulerYearViewBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/scheduleryearviewbuilder) instance.

#### Example

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

### Title(System.String)

The user-friendly title of the view displayed by the scheduler.

#### Parameters

##### title - `System.String`

The title

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Views(views =>
                {
                    views.DayView(dayView => {
                        dayView.Title("Day");
                    });
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### Editable(System.Action)

Sets the editing configuration of the current scheduler view.

#### Parameters

##### configurator - System.Action<[SchedulerViewEditableSettingsBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/schedulervieweditablesettingsbuilder)>

The lambda which configures the editing

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Editable(editable =>
                {
                    editable.Confirmation(false);
                    editable.TemplateId("customEditTemplate");
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### Editable(System.Boolean)

If set to true the user would be able to create new scheduler events and modify or delete existing ones. Default value is true.

#### Parameters

##### isEditable - `System.Boolean`

The isEditable

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Views(views =>
                {
                    views.DayView(dayView => {
                        dayView.Title("Day");
                        dayView.Editable(false);
                    });
                    views.AgendaView();
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### EventTemplate(System.String)

Defines the template used by the view to render the Scheduler events. The available fields in the template are: - description: The event description. - end: The event end date. - resources: The event resources. - start: The event start date. - title: The event title.

#### Parameters

##### eventTemplate - `System.String`

The value that configures the template content.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Screening>()
            	.Name("scheduler")
                .Views(views =>
                {
                    views.DayView(dayView => dayView.EventTemplate(
            		"<div style='color:white'>" +
            			"<img src='" + Url.Content("~/Content/web/scheduler/") + "#= Image #' style='float:left'>" +
            			"<p>" +
            				"#: kendo.toString(Start, 'hh:mm') # - #: kendo.toString(End, 'hh:mm') #" +
            			"</p>" +
            			"<h3>#: title #</h3>" +
            				"<a href='#= Imdb #' style='color:white'>Movie in IMDB</a>" +
            		"</div>"));
                })
            )
             
```

### EventTemplateId(System.String)

Defines the template used by the view to render the Scheduler events. The available fields in the template are: - description: The event description. - end: The event end date. - resources: The event resources. - start: The event start date. - title: The event title.

#### Parameters

##### eventTemplateId - `System.String`

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

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Screening>()
            	.Name("scheduler")
                .Views(views =>
                {
                    views.DayView(dayView => dayView.EventTemplateId("customEventTemplate"));
                })
            )
             
```

### EventTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Defines the template used by the view to render the Scheduler events. The available fields in the template are: - description: The event description. - end: The event end date. - resources: The event resources. - start: The event start date. - title: The event title.

#### Parameters

##### eventTemplateView - `Microsoft.AspNetCore.Html.IHtmlContent`

The Razor View that contains the template.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Activity>()
                .Name("scheduler")
                .Views(views =>
                {
                    views.DayView(dayView => dayView.EventTemplateView(Html.Partial("EventTemplateView")));
                })
            )
             
```

### EventTemplateHandler(System.String)

Defines the template used by the view to render the Scheduler events. The available fields in the template are: - description: The event description. - end: The event end date. - resources: The event resources. - start: The event start date. - title: The event title.

#### Parameters

##### eventTemplateHandler - `System.String`

The JavaScript function that returns the template.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Activity>()
                .Name("scheduler")
                .Views(views =>
                {
                    views.DayView(dayView => dayView.EventTemplateHandler("getEventTemplate"));
                })
            )
             
```

### EventTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Defines the template used by the view to render the Scheduler events. The available fields in the template are: - description: The event description. - end: The event end date. - resources: The event resources. - start: The event start date. - title: The event title.

#### Parameters

##### template - TemplateBuilder\<TModel>

A Template component that configures the template.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Activity>()
                .Name("scheduler")
                .Views(views =>
                {
                    views.DayView(dayView => dayView.EventTemplate(Html.Kendo().Template().AddHtml("<h3>${data.title}</h3>")));
                })
            )
             
```

### SelectedDateFormat(System.String)

The format used to display the selected date. Uses kendo.format. Contains two placeholders - "{0}" and "{1}" which represent the start and end date displayed by the view.

#### Parameters

##### selectedDateFormat - `System.String`

The selectedDateFormat.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Views(views =>
                {
                    views.DayView(dayView => {
                        dayView.Title("Day");
                        dayView.Editable(false);
                        dayView.SelectedDateFormat("{0:dd-MM-yyyy}");
                    });
                    views.AgendaView();
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### SelectedShortDateFormat(System.String)

The format used to display the short selected date. Uses kendo.format. Contains two placeholders - "{0}" and "{1}" which represent the start and end date displayed by the view.

#### Parameters

##### selectedShortDateFormat - `System.String`

The selectedShortDateFormat.

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Views(views =>
                {
                    views.DayView(dayView => {
                        dayView.Title("Day");
                        dayView.Editable(false);
                        dayView.SelectedShortDateFormat("{0:dd-MM-yyyy}");
                    });
                    views.AgendaView();
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### Selected(System.Boolean)

If set to true the view will be initially selected by the scheduler widget. Default value is false.

#### Parameters

##### isSelected - `System.Boolean`

The isSelected

#### RETURNS

Returns the current  instance.

#### Example

```
 
            @(Html.Kendo().Scheduler<Kendo.Mvc.Examples.Models.Scheduler.Task>()
                .Name("scheduler")
                .Date(new DateTime(2013, 6, 13))
                .Views(views =>
                {
                    views.DayView(dayView => {
                        dayView.Title("Day");
                        dayView.Editable(false);
                        dayView.SelectedDateFormat("{0:dd-MM-yyyy}");
                        dayView.Selected(true);
                    });
                    views.AgendaView();
                })
                .DataSource(d => d
                    .Model(m => m.Id(f => f.TaskID))
                        .Read("Read", "Scheduler")
                        .Create("Create", "Scheduler")
                        .Destroy("Destroy", "Scheduler")
                        .Update("Update", "Scheduler")
                )
            )
             
```

### Groups(Kendo.Mvc.UI.SchedulerGroupOrientation)

Sets the orientation of the group headers

#### Parameters

##### orientation - [SchedulerGroupOrientation](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui/schedulergrouporientation)

The orientation

#### Example

```
 
                @(Html.Kendo().Scheduler<Activity>()
                    .Name("scheduler")
                    .Views(v=> { v.TimelineMonthView(t => t.Groups(SchedulerGroupOrientation.Default)); })
                )
             
```

### Groups(System.Boolean)

Sets grouping by date

#### Parameters

##### date - `System.Boolean`

The grouping by date

#### RETURNS

Returns the current  instance.

#### Example

```
 
                @(Html.Kendo().Scheduler<Activity>()
                    .Name("scheduler")
                    .Views(v=> { v.TimelineMonthView(t => t.Groups(true)); })
                )
             
```

### Groups(System.Action)

Sets the resources grouping configuration of the view.

#### Parameters

##### configuration - System.Action<[SchedulerGroupBuilder](https://www.telerik.com/aspnet-core-ui/documentation/api/kendo.mvc.ui.fluent/schedulergroupbuilder)>

The lambda which configures the view grouping

#### RETURNS

Returns the current  instance.

#### Example

```
 
                @(Html.Kendo().Scheduler<Activity>()
                    .Name("scheduler")
                    .Views(v=> { v.TimelineMonthView(t => t.Groups(x=>x.Date(true))); })
                )
             
```