Skip to main content

OptionsBehavior.ClientTimeZoneId Property

Gets or sets the identifier of the time zone used by the SchedulerControl.

Namespace: DevExpress.Xpf.Scheduler

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

NuGet Package: DevExpress.Wpf.Scheduler

Declaration

public string ClientTimeZoneId { get; set; }

Property Value

Type Description
String

A string that uniquely identifies a particular time zone and corresponds to the System.TimeZoneInfo.Id property value.

Property Paths

You can access this nested property as listed below:

Object Type Path to ClientTimeZoneId
SchedulerControl
.OptionsBehavior .ClientTimeZoneId

Remarks

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

This property enables you to set the SchedulerControl’s time zone irrespective of the host time zone settings. The scheduler uses string identifiers for time zones defined on a local system. Time zones in .NET are represented by a TimeZoneInfo class. Time zones in the Windows system can be enumerated and obtained as described in the corresponding MSDN articles. See the Finding the Time Zones Defined on a Local System article for more information.

To specify whether the Time Ruler time zone settings are synchronized with the SchedulerControl’s settings, set the TimeRuler.UseClientTimeZone property to true.

Example

This example demonstrates how to specify basic characteristics of the Scheduler control using the SchedulerControl.OptionsBehavior property.

<dxsch:SchedulerControl.OptionsBehavior>
    <dxsch:OptionsBehavior ClientTimeZoneId="Central Pacific Standard Time" 
                           RecurrentAppointmentDeleteAction="Ask" 
                           RecurrentAppointmentEditAction="Occurrence"
                           RemindersFormDefaultAction="DismissAll"
                           ShowRemindersForm="True" 
                           SelectOnRightClick="True"/>
</dxsch:SchedulerControl.OptionsBehavior>
See Also