TimeRuler Class

Namespace: DevExpress.Xpf.Scheduling

Assembly: DevExpress.Xpf.Scheduling.v24.1.dll

NuGet Package: DevExpress.Wpf.Scheduling

Declaration

C#
VB.NET

public class TimeRuler :
    SchedulerFrameworkComponent

Public Class TimeRuler
    Inherits SchedulerFrameworkComponent

The following members return TimeRuler objects:

Remarks

Time rulers can be shown in the Day View, WorkWeek View and Week View Scheduler views.

Time rulers display the time of the view’s visible interval, specified by the DayViewBase.VisibleTime property. A view may have several rulers, contained in the DayViewBase.TimeRulers collection.

WPFScheduler_TimeRuler

The time ruler’s TimeRuler.Caption property specifies the ruler’s caption - a text shown in the header. Commonly, captions are used to indicate a time zone or geographical region whose standard time a ruler displays. A time zone whose time a time ruler displays is specified by the TimeRuler.TimeZone property.

The TimeRuler.ShowMinutes property allows you to specify whether minutes are displayed.

The DayViewBase.TimeMarkerVisibility property allows you to show or hide the time marker - a visual element indicating the current time.

The following code defines a Day View with two time rulers. The time ruler’s time indicator is visible only when the view contains the current date. The time rulers display different time zones - one ruler is set for LA, the other for NYC.

XAML

<dxsch:DayView TimeMarkerVisibility="TodayView">
    <dxsch:DayView.TimeRulers>
        <dxsch:TimeRulerCollection>
            <dxsch:TimeRuler ShowMinutes="False"
                             TimeZone="Pacific Standard Time"
                             Caption="LA"/>
            <dxsch:TimeRuler ShowMinutes="True"
                             TimeZone="Eastern Standard Time"
                             Caption="NYC"/>
        </dxsch:TimeRulerCollection>
    </dxsch:DayView.TimeRulers>
</dxsch:DayView>

Example

The following example demonstrates how to add multiple time rulers to the scheduler’s Day View using the MVVM architectural pattern.

Use the DayViewBase.TimeRulersSource property to bind the view to a collection of objects containing time ruler settings described in the ViewModel. The DayViewBase.TimeRulerTemplate property specifies a data template based on which time rulers are generated.

Create a custom style for the TimeRulerCellControl to specify format strings for displaying time in the time rulers’ time scale.

View Example

<dx:ThemedWindow x:Class="WpfSchedulerTimeRulers.MainWindow" mc:Ignorable="d" Title="Time Rulers" Height="500" Width="800" 
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    xmlns:local="clr-namespace:WpfSchedulerTimeRulers"
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm"
    xmlns:dxsch="http://schemas.devexpress.com/winfx/2008/xaml/scheduling"
    xmlns:dxschv="http://schemas.devexpress.com/winfx/2008/xaml/scheduling/visual"
    DataContext="{dxmvvm:ViewModelSource local:MainViewModel}">

    <dx:ThemedWindow.Resources>
        <DataTemplate x:Key="TimeRulerGeneratorTemplate">
            <ContentControl>
                <dxsch:TimeRuler Caption="{Binding Caption}" ShowMinutes="{Binding ShowMinutes}" TimeZone="{Binding TimeZone}" AlwaysShowTimeDesignator="{Binding AlwaysShowTimeDesignator}"/>
            </ContentControl>
        </DataTemplate>

        <Style TargetType="{x:Type dxschv:TimeRulerCellControl}">
            <Setter Property="HourStringFormat" Value="{}{0:HH}"/>
            <Setter Property="MinuteStringFormat" Value="{}{0:mm}"/>
        </Style>
    </dx:ThemedWindow.Resources>

    <Grid>
        <dxsch:SchedulerControl x:Name="scheduler">
            <dxsch:DayView x:Name="dayView" ShowWorkTimeOnly="True" TimeScale="00:30:00" TimeRulersSource="{Binding TimeRulers}" TimeRulerTemplate="{StaticResource TimeRulerGeneratorTemplate}"/>
        </dxsch:SchedulerControl>
    </Grid>
</dx:ThemedWindow>

Imports System
Imports System.Collections.ObjectModel
Imports DevExpress.Mvvm.POCO

Namespace WpfSchedulerTimeRulers
    Public Class MainViewModel
        Private privateTimeRulers As ObservableCollection(Of TimeRulerViewModel)
        Public Overridable Property TimeRulers() As ObservableCollection(Of TimeRulerViewModel)
            Get
                Return privateTimeRulers
            End Get
            Protected Set(ByVal value As ObservableCollection(Of TimeRulerViewModel))
                privateTimeRulers = value
            End Set
        End Property

        Protected Sub New()
            CreateTimeRulers()
        End Sub

        Private Sub CreateTimeRulers()
            TimeRulers = New ObservableCollection(Of TimeRulerViewModel)()
            TimeRulers.Add(TimeRulerViewModel.Create("GMT", TimeZoneInfo.FindSystemTimeZoneById("GMT Standard Time")))
            TimeRulers.Add(TimeRulerViewModel.Create("Local", TimeZoneInfo.Local))
        End Sub
    End Class

    Public Class TimeRulerViewModel
        Public Shared Function Create() As TimeRulerViewModel
            Return ViewModelSource.Create(Function() New TimeRulerViewModel())
        End Function

        Public Shared Function Create(ByVal caption As String, ByVal timeZoneInfo As TimeZoneInfo) As TimeRulerViewModel
            Dim timeRuler As TimeRulerViewModel = TimeRulerViewModel.Create()
            timeRuler.Caption = caption
            timeRuler.TimeZone = timeZoneInfo
            timeRuler.AlwaysShowTimeDesignator = False
            timeRuler.ShowMinutes = False
            Return timeRuler
        End Function

        Protected Sub New()
        End Sub
        Public Overridable Property Caption() As String
        Public Overridable Property TimeZone() As TimeZoneInfo
        Public Overridable Property AlwaysShowTimeDesignator() As Boolean
        Public Overridable Property ShowMinutes() As Boolean
    End Class
End Namespace

using System;
using System.Collections.ObjectModel;
using DevExpress.Mvvm.POCO;

namespace WpfSchedulerTimeRulers
{
    public class MainViewModel
    {
        public virtual ObservableCollection<TimeRulerViewModel> TimeRulers { get; protected set; }

        protected MainViewModel()
        {
            CreateTimeRulers();
        }

        private void CreateTimeRulers()
        {
            TimeRulers = new ObservableCollection<TimeRulerViewModel>();
            TimeRulers.Add(TimeRulerViewModel.Create("GMT", TimeZoneInfo.FindSystemTimeZoneById("GMT Standard Time")));
            TimeRulers.Add(TimeRulerViewModel.Create("Local", TimeZoneInfo.Local));
        }
    }

    public class TimeRulerViewModel
    {
        public static TimeRulerViewModel Create()
        {
            return ViewModelSource.Create(() => new TimeRulerViewModel());
        }

        public static TimeRulerViewModel Create(string caption, TimeZoneInfo timeZoneInfo)
        {
            TimeRulerViewModel timeRuler = TimeRulerViewModel.Create();
            timeRuler.Caption = caption;
            timeRuler.TimeZone = timeZoneInfo;
            timeRuler.AlwaysShowTimeDesignator = false;
            timeRuler.ShowMinutes = false;
            return timeRuler;
        }

        protected TimeRulerViewModel() { }
        public virtual string Caption { get; set; }
        public virtual TimeZoneInfo TimeZone { get; set; }
        public virtual bool AlwaysShowTimeDesignator { get; set; }
        public virtual bool ShowMinutes { get; set; }
    }
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TimeRuler class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-scheduler-generate-time-rulers-from-view-model-collection/CS/WpfSchedulerTimeRulers/MainWindow.xaml#L16

<ContentControl>
    <dxsch:TimeRuler Caption="{Binding Caption}" ShowMinutes="{Binding ShowMinutes}" TimeZone="{Binding TimeZone}" AlwaysShowTimeDesignator="{Binding AlwaysShowTimeDesignator}"/>
</ContentControl>