SchedulerOptionsBehaviorBase.ClientTimeZoneId Property

Gets or sets the client time zone of the Scheduler.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.Core.Desktop.dll

NuGet Package: DevExpress.Scheduler.CoreDesktop

Declaration

C#

[TypeConverter(typeof(TimeZoneIdStringTypeConverter))]
[XtraSerializableProperty]
public string ClientTimeZoneId { get; set; }

VB.NET

<TypeConverter(GetType(TimeZoneIdStringTypeConverter))>
<XtraSerializableProperty>
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.

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.

Related GitHub Examples

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

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.

C#

winforms-scheduler-find-free-time-intervals/CS/FreeTimeIntervals/Form1.cs#L25

    timeZoneHelper = new TimeZoneHelper(this.schedulerControl1.OptionsBehavior.ClientTimeZoneId);
}

VB.NET

winforms-scheduler-find-free-time-intervals/VB/FreeTimeIntervals/Form1.vb#L41

    appointmentsTableAdapter.Fill(xtraSchedulingDataSet.Appointments)
    timeZoneHelperField = New TimeZoneHelper(schedulerControl1.OptionsBehavior.ClientTimeZoneId)
End Sub