SchedulerOptionsBehaviorBase.ClientTimeZoneId Property

Gets or sets the client time zone of the Scheduler.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.1.Core.dll

Declaration

public string ClientTimeZoneId { get; set; }
Public Property ClientTimeZoneId As String

Property Value

Type Description
String

A key string that uniquely identifies a particular time zone; its value should match to the System.TimeZoneInfo.Id property values for the time zones in the registry.

Property Paths

You can access this nested property as listed below:

Library Object Type Path to ClientTimeZoneId
WinForms Controls SchedulerControl
.OptionsBehavior.ClientTimeZoneId
ASP.NET Controls and MVC Extensions ASPxScheduler
.OptionsBehavior.ClientTimeZoneId
MVCxScheduler
.OptionsBehavior.ClientTimeZoneId
SchedulerSettings
.OptionsBehavior.ClientTimeZoneId
ASP.NET Bootstrap Controls BootstrapScheduler
.OptionsBehavior.ClientTimeZoneId
BootstrapScheduler
.OptionsBehavior.ClientTimeZoneId

Remarks

The ClientTimeZoneId value is passed to the System.TimeZoneInfo.FindSystemTimeZoneById method to retrieve a TimeZoneInfo object from the registry. The obtained TimeZoneInfo is used in the TimeZoneHelper class instance for internal DateTime value conversion between time zones.

This property enables you to set the Scheduler time zone irrespective of the host time zone settings. See the Scheduler Time Zones document for more information on time zone support in the Scheduler.

In the ASPxScheduler, you can use this property to obtain or assign the client time zone. The following picture illustrates how the ClientTimeZoneId property could be set for the ASPxScheduler control via the ASPxTimeZoneEdit control. The time rulers display GMT, server and client times. The Client time ruler has its TimeRuler.UseClientTimeZone property set to true.

ClientTimeZoneId

See Also