TimeScale.DisplayFormat Property

Gets or sets the format of the string displayed in the timeline caption.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v14.2.Core.dll

Declaration

C#

[TypeConverter(typeof(DateTimeFormatConverter))]
[DefaultValue("")]
[XtraSerializableProperty(XtraSerializationFlags.DefaultValue)]
public string DisplayFormat { get; set; }

VB.NET

<TypeConverter(GetType(DateTimeFormatConverter))>
<DefaultValue("")>
<XtraSerializableProperty(XtraSerializationFlags.DefaultValue)>
Public Property DisplayFormat As String

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the format string of the caption.

Examples

This example illustrates how to access the time scale collection of the Timeline View (via the TimelineView.Scales property) and add TimeScale elements to be available for end-users (for example, TimeScaleMonth, TimeScaleWeek and TimeScaleDay). This approach can be helpful if you wish to hide specific time intervals in the Timeline View.

To change the format of a single scale header, adjust the TimeScale.DisplayFormat property of the corresponding TimeScale object.

You can also implement your own custom time scales and add them to the TimelineView.Scales collection. This example demonstrates the comparatively simple task of creating a scale with a fixed interval (four hours) by inheriting from the TimeScaleFixedInterval class. For more complex tasks, use the TimeScale descendants and override key methods.