Timeline Views in WPF Scheduler (SfScheduler)

18 Dec 2020 / 22 minutes to read

The TimelineView displays the dates in horizontal time axis with the desired day’s count. Scheduler supports to display the TimelineDay, TimelineWeek, TimelineWorkWeek, and TimelineMonth views. You can see the past or future dates by scrolling to the right or left. Each view displays the events accurately across the time slots with an intuitive drag-and-drop feature. It provides the support to highlight the selected region of time slots and handle the interaction.

Change time interval

You can customize the interval of timeslots in the timeline views by using the TimeInterval property of TimelineViewSettings. This property will be applicable to TimelineDay, TimelineWeek, and TimelineWorkWeek views.

Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimeInterval = new System.TimeSpan(0, 120, 0);

Change Time Interval in WPF Scheduler

NOTE

If you modify the timeInterval value (in minutes), you need to change the time labels format by setting the timeFormat value to hh:mm.

Change time interval width

You can customize the interval width of timeslots in the Timeline views by setting the TimeIntervalSize property of TimelineViewSettings. This property will be applicable to all timeline views. By default, its value is fifty for the TimelineDay, TimelineWeek, and TimelineWorkWeek views and 150 for TimelineMonth view.

<syncfusion:SfScheduler x:Name="Schedule"
ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            TimeIntervalHeight="120"/>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimeIntervalHeight = 120;

Change time interval height in WPF Scheduler

Flexible working days and working hours

The default values for the StartHour and EndHour are 0 and 24 to show all the time slots in a timeline view. You can set the StartHour and EndHour properties of TimelineViewSettings to show only the required time duration for users. You can set the StartHour and EndHour in time duration to show the required time duration in minutes. The StartHour and EndHour properties are not applicable to the TimelineMonth view.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            StartHour="8"
            EndHour="15"/>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.StartHour = 8;
Schedule.TimelineViewSettings.EndHour = 15;

Flexible working days and working hours in WPF Scheduler

NOTE

  • The NonWorkingDays property will applicable only for workWeek and TimelineWorkWeek views only, and not applicable for the remaining views.
  • Scheduler Appointments UI, which does not fall within the StartHour and EndHour will not be visible and if it falls partially, it will be clipped.
  • No need to specify the decimal point values for StartHour and EndHour, if you don’t want to set the minutes.
  • The number of time slots will be calculated based on total minutes of a day and time interval (total minutes of a day ((start hour - end hour) * 60) / time interval).
  • If custom timeInterval is given, then the number of time slots calculated based on the given TimeInterval should result in integer value (total minutes % timeInterval = 0), otherwise next immediate time interval that result in integer value when divide total minutes of a day will be considered. For example, if TimeInterval=2 Hours 15 minutes and total minutes = 1440 (24 Hours per day), then TimeInterval will be changed to ‘144’ (1440%144=0) by considering (total minutes % TimeInterval = 0), it will return integer value for time slots rendering.
  • If the custom StartHour and EndHour are given, then the number of time slots calculated based on given StartHour and EndHour should result in integer value, otherwise next immediate TimeInterval will be considered until the result is integer value. For example, if StartHour is 9 (09:00AM), EndHour is 18.25 (06:15 PM), TimeInterval is 30 minutes, and total minutes = 555 ((18.25-9)*60), then the TimeInterval will be changed to ’37 minutes’ (555%37=0) by considering (total minutes % timeInterval = 0). it will return integer value for time slots rendering.

Change days count

You can change the day’s count of timeslots in the timeline view by setting the DaysCount property of TimelineViewSettings. This property is only applicable for the TimelineDay view. By default, its value is set to 1.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineDay">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            DaysCount="2"/>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineDay;
Schedule.TimelineViewSettings.DaysCount = 2;

DaysCount in TimelineDay WPF Scheduler

Blackout dates

You can disable the interaction for certain dates in the scheduler TimelineMonth view by adding those specific dates to the BlackoutDates collection property of SfScheduler. Using this, you can allocate or restrict the specific dates for predefined events. This property is not applicable to the TimelineDay, TimelineWeek, and TimelineWorkWeek views.

this.Schedule.ViewType = SchedulerViewType.Month;

this.Schedule.BlackoutDates = GetBlackoutDates();

private ObservableCollection<DateTime> GetBlackoutDates()
        {
            var blackoutDateCollection = new ObservableCollection<DateTime>()
            {
                DateTime.Now.Date.AddDays(1),
                DateTime.Now.Date.AddDays(3),
                DateTime.Now.Date.AddDays(5),
                DateTime.Now.Date.AddDays(7),
                DateTime.Now.Date.AddDays(9)
            };
            return blackoutDateCollection;
        }

WPF Scheduler TimelineMonth view BlackoutDates

Special time regions

You can restrict the user interaction such as selection and highlights specific regions of time in the timeline views by adding the SpecialTimeRegions property of SfScheduler. You need to set the StartTime and EndTime properties of SpecialTimeRegion to create a SpecialTimeRegion, you can use the timeZone property to set the specific timezone for the start and end time of the SpecialTimeRegion. The SpecialTimeRegion will display the text or image on it that set to the text or icon property of SpecialTimeRegion. This property will be applicable to the TimelineDay, TimelineWeek, and TimelineWorkWeek views.

Selection restriction in timeslots

You can enable or disable the touch interaction of SpecialTimeRegion using the CanEdit property of SpecialTimeRegion. By default, its value is true.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek" >
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings>
            <syncfusion:TimelineViewSettings.SpecialTimeRegions>
                <syncfusion:SpecialTimeRegion
                    StartTime="2020/07/08 13:0:0"
                    EndTime="2020/07/08 14:0:0"
                    CanEdit="False"
                    Text="Lunch"
                    Background="Black"
                    Foreground="White"/>
            </syncfusion:TimelineViewSettings.SpecialTimeRegions>
        </syncfusion:TimelineViewSettings>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.SpecialTimeRegions.Add(new SpecialTimeRegion
{
    StartTime = new System.DateTime(2020, 07, 08, 13, 0, 0),
    EndTime = new System.DateTime(2020, 07, 08, 14, 0, 0),
    Text = "Lunch",
    CanEdit = false,
    Background = Brushes.Black,
    Foreground = Brushes.White
});

Selection restriction in timeslots in WPF Scheduler

NOTE

This property only restricts the interaction on region and it does not restrict the following:

  • Programmatic selection (if the user updates the selected date value dynamically)
  • Does not clear the selection when the user selects the region and dynamically change
    the CanEdit property to false
  • It does not restrict appointment interaction when the appointment placed
    in the region
  • It does not restrict the appointment rendering on a region, when appointments are loaded from data services or adding programmatically.

Recurring time region

The recurring time region on a daily, weekly, monthly, or yearly interval. The recurring special time regions can be created by setting the RecurrenceRule property in SpecialTimeRegion.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWorkWeek" >
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings>
            <syncfusion:TimelineViewSettings.SpecialTimeRegions>
                <syncfusion:SpecialTimeRegion
                    StartTime="2020/07/08 13:0:0"
                    EndTime="2020/07/08 14:0:0"
                    CanEdit="False"
                    Text="Lunch"
                    Background="Black"
                    Foreground="White"
                    RecurrenceRule="FREQ=DAILY;INTERVAL=1"/>
            </syncfusion:TimelineViewSettings.SpecialTimeRegions>
        </syncfusion:TimelineViewSettings>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWorkWeek;
Schedule.TimelineViewSettings.SpecialTimeRegions.Add(new SpecialTimeRegion
{
    StartTime = new System.DateTime(2020, 07, 08, 13, 0, 0),
    EndTime = new System.DateTime(2020, 07, 08, 14, 0, 0),
    Text = "Lunch",
    CanEdit = false,
    Background = Brushes.Black,
    Foreground = Brushes.White,
    RecurrenceRule= "FREQ=DAILY;INTERVAL=1"
});

Recurrence exception dates

You can delete any of occurrence that is an exception from the recurrence pattern time region by using the RecurrenceExceptionDates property of SpecialTimeRegion. The deleted occurrence date will be considered as a recurrence exception date.

Schedule.ViewType = SchedulerViewType.TimelineWeek;
DateTime recurrenceExceptionDates = new DateTime(2020, 07, 06, 10, 0, 0);
DateTime recurrenceExceptionDates1 = new DateTime(2020, 07, 08, 10, 0, 0);
DateTime recurrenceExceptionDates2 = new DateTime(2020, 07, 10, 10, 0, 0);
Schedule.TimelineViewSettings.SpecialTimeRegions.Add(new SpecialTimeRegion
{
    StartTime = new System.DateTime(2020, 05, 05, 12, 0, 0),
    EndTime = new System.DateTime(2020, 05, 05, 13, 0, 0),
    Text = "Lunch",
    CanEdit = false,
    Background = Brushes.Black,
    Foreground = Brushes.White,
    RecurrenceRule = "FREQ=DAILY;INTERVAL=1",
    RecurrenceExceptionDates = new ObservableCollection<DateTime>()
{
    recurrenceExceptionDates,
    recurrenceExceptionDates1,
    recurrenceExceptionDates2,
}
});

Special time region customization

The SpecialTimeRegion background color can be customized by using the Background and SpecialTimeRegionTemplate properties of SpecialTimeRegion that is used to customize the text style for the image of the SpecialTimeRegion.

<Window.Resources>
    <DataTemplate x:Key="specialRegionTemplate">
        <Grid Background="{Binding Background}"
            HorizontalAlignment="Stretch"
            VerticalAlignment="Stretch">
        <Image x:Name="Image"
            HorizontalAlignment="Center"
            VerticalAlignment="Center"
            Source="../Image/Fork.png"/>
        </Grid>
    </DataTemplate>
</Window.Resources>
<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings                 SpecialTimeRegionTemplate="{StaticResource specialRegionTemplate}">
            <syncfusion:TimelineViewSettings.SpecialTimeRegions>
                <syncfusion:SpecialTimeRegion
                    StartTime="01/01/2020 13:0:0"
                    EndTime="01/01/2020 14:0:0"
                    CanEdit="False"
                    Text="LUNCH"
                    RecurrenceRule="FREQ=DAILY;INTERVAL=1"
                    Foreground="Black"
                    Background="#FFF5F5F5"/>
            </syncfusion:TimelineViewSettings.SpecialTimeRegions>
        </syncfusion:TimelineViewSettings>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>

Special time region customization in WPF Scheduler

Full screen scheduler

Scheduler time interval height can be adjusted based on screen height by changing the value of TimeIntervalHeight property to -1. It will auto-fit to the screen height and width.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            TimeIntervalHeight="-1"/>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimeIntervalHeight = -1;

Full screen scheduler in WPF Scheduler

Change time ruler size

You can customize the size of the time ruler view where the labels mentioning the time are placed by using the TimeRulerSize property of TimelineViewSettings. This property will be applicable to TimelineDay, TimelineWeek, and TimelineWorkWeek views.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek" >
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings   
            TimeRulerSize="100">
        </syncfusion:TimelineViewSettings>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimeRulerSize = 100;

Change time ruler size in WPF Scheduler

Minimum appointment duration

The MinimumAppointmentDuration property in the TimelineViewSettings is to set an arbitrary height to appointments when it has a minimum duration in timeline view so that the subject can be readable. This property will not applicable for the TimelineMonth view.

Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.MinimumAppointmentDuration = new System.TimeSpan(0, 120, 0);

NOTE

  • The MinimumAppointmentDuration value will be set, when an appointment duration value lesser than MinimumAppointmentDuration.
  • Appointment duration value will be set, when the appointment duration value greater than MinimumAppointmentDuration.
  • TimeInterval value will be set, when MinimumAppointmentDuration greater than TimeInterval with lesser appointment duration.
  • All day Appointment does not support MinimumAppointmentDuration.

Time text formatting

You can customize the format for the labels mentioning the time, by setting the TimeRulerFormat property of TimelineViewSettings in the Scheduler. This property will not applicable for the TimelineMonth view.

Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimeRulerFormat = "hh mm";
Schedule.TimelineViewSettings.TimeInterval = new System.TimeSpan(0, 30, 0);

Time text formatting in WPF Scheduler

View header

You can customize the default appearance of view header in the timeline views by setting the ViewHeaderDateFormat, ViewHeaderHeight, ViewHeaderDayFormat, and ViewHeaderTemplate of TimelineViewSettings.

View header text formatting

You can customize the date and day format of ViewHeader by using the ViewHeaderDateFormat and ViewHeaderDayFormat properties of TimelineViewSettings.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            ViewHeaderDateFormat="dd/MMMM"/>
        </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.ViewHeaderDateFormat="dd/MMMM";

View header text formatting in WPF Scheduler

View header height

You can customize the height of the ViewHeader in timeline views by setting ViewHeaderHeight property of TimelineViewSettings in SfScheduler.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings
            ViewHeaderHeight="100"/>
        </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.ViewHeaderHeight = 100;

View header height in WPF Scheduler

View header appearance customization

You can customize the default appearance of view header by setting ViewHeaderTemplate property of TimelineViewSettings in SfScheduler.

<Window.Resources>
<DataTemplate x:Key="viewHeaderTemplate">
    <StackPanel Background="Green"  
        Width="2000"
        VerticalAlignment="Stretch" 
        HorizontalAlignment="Stretch"
        Orientation="Vertical">
    <TextBlock 
        HorizontalAlignment="Left" 
        Margin="20,0,0,0" 
        Foreground="#FFFFFF"
        FontFamily="Arial"
        Text="{Binding DateText}"
        FontSize="25"
        TextTrimming="CharacterEllipsis"
        TextWrapping="Wrap" />
    <TextBlock 
        HorizontalAlignment="Left"  Margin="20,0,0,0" 
        Foreground="#FFFFFF"
        FontFamily="Arial"
        Text="{Binding DayText}"
        FontSize="10"
        TextTrimming="CharacterEllipsis"
        TextWrapping="Wrap" />
    </StackPanel>
</DataTemplate>
</Window.Resources>
<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek">
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            ViewHeaderTemplate="{StaticResource viewHeaderTemplate}" />
        </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>

ViewHeader appearance customization in WPF Scheduler

Appointment height

You can customize the height of the appointment in TimelineView using the TimelineAppointmentHeight property of the TimelineViewSettings. By default, its value is fifty for the TimelineWeek, TimelineWorkWeek, and TimelineDay views and twenty for the TimelineMonth view.

<syncfusion:SfScheduler x:Name="Schedule" ViewType="TimelineWeek"> 
    <syncfusion:SfScheduler.TimelineViewSettings>
        <syncfusion:TimelineViewSettings 
            TimelineAppointmentHeight="100">
        </syncfusion:TimelineViewSettings>
    </syncfusion:SfScheduler.TimelineViewSettings>
</syncfusion:SfScheduler>
Schedule.ViewType = SchedulerViewType.TimelineWeek;
Schedule.TimelineViewSettings.TimelineAppointmentHeight = 100;

Appointment height in WPF Scheduler