TimeRuler.UseClientTimeZone Property

Gets or sets whether a particular TimeRuler always uses the ClientTimeZoneId setting.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.2.Core.Desktop.dll

NuGet Packages: DevExpress.Scheduler.CoreDesktop, DevExpress.WindowsDesktop.Scheduler.CoreDesktop

Declaration

C#

[DefaultValue(true)]
public bool UseClientTimeZone { get; set; }

VB.NET

<DefaultValue(True)>
Public Property UseClientTimeZone As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true, if a TimeRuler uses ClientTimeZoneId setting; otherwise, false.

Remarks

The Time Ruler element with the UseClientTimeZone property set to true uses the client time zone specified by the SchedulerOptionsBehaviorBase.ClientTimeZoneId property. By default, a client time zone is the same as the time zone of the host.

The time scale of the TimeRuler that uses the client time zone always starts at 00:00 AM. Time scales of time rulers with different time zone settings are shifted relative to the time scale of the time ruler that belongs to the client time zone.

Note

When the TimeRuler.TimeZoneId property of the TimeRuler is modified, the UseClientTimeZone value becomes false.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UseClientTimeZone 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#

how-to-customize-timeruler-time-scales-e5068/CS/CustomTimeRulerSample/MyTimeRulerFormatStringService.cs#L20

{
    return ruler.UseClientTimeZone ? "htt" : "HH:mm";
}

how-to-customize-visual-elements-using-scheduler-services-e1006/CS/CustomFormats/Code/Services.cs#L21

public override string GetHalfDayHourFormat(TimeRuler ruler) {
    return ruler.UseClientTimeZone ? "'HalfDayHour'" : "HH:mm";
}

formatting-services-an-example-of-use-e507/CS/FormattingServicesExample/Form1.cs#L94

public override string GetHalfDayHourFormat(TimeRuler ruler) {
    return ruler.UseClientTimeZone ? "hh:mm" : "HH:mm";
}

VB.NET

how-to-customize-visual-elements-using-scheduler-services-e1006/VB/CustomFormats/Code/Services.vb#L23

Public Overrides Function GetHalfDayHourFormat(ByVal ruler As TimeRuler) As String
    Return If(ruler.UseClientTimeZone, "'HalfDayHour'", "HH:mm")
End Function

how-to-customize-timeruler-time-scales-e5068/VB/CustomTimeRulerSample/MyTimeRulerFormatStringService.vb#L18

Public Overrides Function GetHalfDayHourFormat(ByVal ruler As TimeRuler) As String
    Return If(ruler.UseClientTimeZone, "htt", "HH:mm")
End Function

formatting-services-an-example-of-use-e507/VB/FormattingServicesExample/Form1.vb#L96

Public Overrides Function GetHalfDayHourFormat(ByVal ruler As TimeRuler) As String
    Return If(ruler.UseClientTimeZone, "hh:mm", "HH:mm")
End Function