ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ScheduleViewBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ScheduleViewBuilder

    Inheritance
    System.Object
    ControlBuilder
    ScheduleViewBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Schedule
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class ScheduleViewBuilder : ControlBuilder

    Constructors

    ScheduleViewBuilder()

    Declaration
    public ScheduleViewBuilder()

    ScheduleViewBuilder(List<ScheduleView>)

    Declaration
    public ScheduleViewBuilder(List<ScheduleView> collection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ScheduleView> collection

    Methods

    Add()

    Declaration
    public void Add()

    AllowVirtualScrolling(Boolean)

    It is used to allow or disallow the virtual scrolling functionality on Agenda View. This is applicable only on Agenda view.

    Declaration
    public ScheduleViewBuilder AllowVirtualScrolling(bool allowVirtualScrolling)
    Parameters
    Type Name Description
    System.Boolean allowVirtualScrolling
    Returns
    Type Description
    ScheduleViewBuilder

    CellHeaderTemplate(String)

    It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the month date cells. This template is only applicable for month view day cells.

    Declaration
    public ScheduleViewBuilder CellHeaderTemplate(string cellHeaderTemplate)
    Parameters
    Type Name Description
    System.String cellHeaderTemplate
    Returns
    Type Description
    ScheduleViewBuilder

    CellTemplate(String)

    The template option which is used to render the customized work cells on the Schedule. Here, the template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the work cells. The field accessible via template is date. It gets applied only to the view objects on which it is defined.

    Declaration
    public ScheduleViewBuilder CellTemplate(string cellTemplate)
    Parameters
    Type Name Description
    System.String cellTemplate
    Returns
    Type Description
    ScheduleViewBuilder

    DateFormat(String)

    By default, Schedule follows the date-format as per the default culture assigned to it. It is also possible to manually set specific date format by using the dateFormat property. The format of the date range label in the header bar depends on the dateFormat value or else based on the locale assigned to the Schedule. It gets applied only to the view objects on which it is defined.

    Declaration
    public ScheduleViewBuilder DateFormat(string dateFormat)
    Parameters
    Type Name Description
    System.String dateFormat
    Returns
    Type Description
    ScheduleViewBuilder

    DateHeaderTemplate(String)

    It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the date header cells. The field that can be accessed via this template is date. It gets applied only to the view objects on which it is defined.

    Declaration
    public ScheduleViewBuilder DateHeaderTemplate(string dateHeaderTemplate)
    Parameters
    Type Name Description
    System.String dateHeaderTemplate
    Returns
    Type Description
    ScheduleViewBuilder

    DisplayName(String)

    When the same view is customized with different intervals, this property allows the user to set different display name for those views.

    Declaration
    public ScheduleViewBuilder DisplayName(string displayName)
    Parameters
    Type Name Description
    System.String displayName
    Returns
    Type Description
    ScheduleViewBuilder

    EndHour(String)

    It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.

    Declaration
    public ScheduleViewBuilder EndHour(string endHour)
    Parameters
    Type Name Description
    System.String endHour
    Returns
    Type Description
    ScheduleViewBuilder

    EventTemplate(String)

    It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the event background. All the event fields mapped to Schedule from dataSource can be accessed within this template code. It is similar to that of the template option available within the eventSettings property, whereas it will get applied only on the events of the view to which it is currently being defined.

    Declaration
    public ScheduleViewBuilder EventTemplate(string eventTemplate)
    Parameters
    Type Name Description
    System.String eventTemplate
    Returns
    Type Description
    ScheduleViewBuilder

    FirstDayOfWeek(Double)

    This option allows the user to set the first day of a week on Schedule. It should be based on the locale set to it and each culture defines its own first day of week values. If needed, the user can set it manually on his own by defining the value through this property. It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.

    Declaration
    public ScheduleViewBuilder FirstDayOfWeek(double firstDayOfWeek)
    Parameters
    Type Name Description
    System.Double firstDayOfWeek
    Returns
    Type Description
    ScheduleViewBuilder

    Group(ScheduleGroup)

    Allows to set different resource grouping options on all available schedule view modes.

    Declaration
    public ScheduleViewBuilder Group(ScheduleGroup group)
    Parameters
    Type Name Description
    ScheduleGroup group
    Returns
    Type Description
    ScheduleViewBuilder

    Group(Action<ScheduleGroupBuilder>)

    Declaration
    public ScheduleViewBuilder Group(Action<ScheduleGroupBuilder> group)
    Parameters
    Type Name Description
    System.Action<ScheduleGroupBuilder> group
    Returns
    Type Description
    ScheduleViewBuilder

    HeaderRows(Object)

    Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row on the timeline view of the scheduler.

    Declaration
    public ScheduleViewBuilder HeaderRows(object headerRows)
    Parameters
    Type Name Description
    System.Object headerRows
    Returns
    Type Description
    ScheduleViewBuilder

    Interval(Double)

    It accepts the number value denoting to include the number of days, weeks, workweeks or months on the defined view type.

    Declaration
    public ScheduleViewBuilder Interval(double interval)
    Parameters
    Type Name Description
    System.Double interval
    Returns
    Type Description
    ScheduleViewBuilder

    IsSelected(Boolean)

    To denote whether the view name given on the option is active or not. It acts similar to the currentView property and defines the active view of Schedule.

    Declaration
    public ScheduleViewBuilder IsSelected(bool isSelected)
    Parameters
    Type Name Description
    System.Boolean isSelected
    Returns
    Type Description
    ScheduleViewBuilder

    Option(View)

    It accepts the schedule view name, based on which we can define with its related properties in a single object. The applicable view names are, Day Week WorkWeek Month Year Agenda MonthAgenda TimelineDay TimelineWeek TimelineWorkWeek TimelineMonth TimelineYear

    Declaration
    public ScheduleViewBuilder Option(View option)
    Parameters
    Type Name Description
    View option
    Returns
    Type Description
    ScheduleViewBuilder

    Orientation(Orientation)

    It is used to specify the year view rendering orientation on the schedule. The applicable orientation values are, Horizontal Vertical

    Declaration
    public ScheduleViewBuilder Orientation(Orientation orientation)
    Parameters
    Type Name Description
    Orientation orientation
    Returns
    Type Description
    ScheduleViewBuilder

    ReadOnly(Boolean)

    When set to true, displays a quick popup with cell or event details on single clicking over the cells or on events. By default, it is set to true. It gets applied only to the view objects on which it is defined.

    Declaration
    public ScheduleViewBuilder ReadOnly(bool readOnly)
    Parameters
    Type Name Description
    System.Boolean readOnly
    Returns
    Type Description
    ScheduleViewBuilder

    ResourceHeaderTemplate(String)

    The template option which is used to render the customized header cells on the schedule. Here, the template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the header cells. All the resource fields mapped within resources can be accessed within this template code. It gets applied only to the view objects on which it is defined.

    Declaration
    public ScheduleViewBuilder ResourceHeaderTemplate(string resourceHeaderTemplate)
    Parameters
    Type Name Description
    System.String resourceHeaderTemplate
    Returns
    Type Description
    ScheduleViewBuilder

    ShowWeekend(Boolean)

    When set to false, it hides the weekend days of a week from the Schedule. The days which are not defined in the working days collection are usually treated as weekend days. Note: By default, this option is not applicable on Work Week view. For example, if the working days are defined as [1, 2, 3, 4], then the remaining days of that week will be considered as the weekend days and will be hidden on all the views.

    Declaration
    public ScheduleViewBuilder ShowWeekend(bool showWeekend)
    Parameters
    Type Name Description
    System.Boolean showWeekend
    Returns
    Type Description
    ScheduleViewBuilder

    ShowWeekNumber(Boolean)

    When set to true, displays the week number of the current view date range.

    Declaration
    public ScheduleViewBuilder ShowWeekNumber(bool showWeekNumber)
    Parameters
    Type Name Description
    System.Boolean showWeekNumber
    Returns
    Type Description
    ScheduleViewBuilder

    StartHour(String)

    It is used to specify the starting hour, from which the Schedule starts to display. It accepts the time string in a short skeleton format and also, hides the time beyond the specified start time.

    Declaration
    public ScheduleViewBuilder StartHour(string startHour)
    Parameters
    Type Name Description
    System.String startHour
    Returns
    Type Description
    ScheduleViewBuilder

    TimeScale(ScheduleTimeScale)

    Allows to set different timescale configuration on each applicable view modes such as day, week and work week.

    Declaration
    public ScheduleViewBuilder TimeScale(ScheduleTimeScale timeScale)
    Parameters
    Type Name Description
    ScheduleTimeScale timeScale
    Returns
    Type Description
    ScheduleViewBuilder

    TimeScale(Action<ScheduleTimeScaleBuilder>)

    Declaration
    public ScheduleViewBuilder TimeScale(Action<ScheduleTimeScaleBuilder> timeScale)
    Parameters
    Type Name Description
    System.Action<ScheduleTimeScaleBuilder> timeScale
    Returns
    Type Description
    ScheduleViewBuilder

    WorkDays(Int32[])

    It is used to set the working days on schedule. The only days that are defined in this collection will be rendered on the workWeek view whereas on other views, it will display all the usual days and simply highlights the working days with different shade.

    Declaration
    public ScheduleViewBuilder WorkDays(int[] workDays)
    Parameters
    Type Name Description
    System.Int32[] workDays
    Returns
    Type Description
    ScheduleViewBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved