TimeRuler.Caption Property

Gets or sets the time ruler’s caption.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

[DefaultValue("")]
[XtraSerializableProperty(XtraSerializationFlags.DefaultValue)]
public string Caption { get; set; }

VB.NET

<DefaultValue("")>
<XtraSerializableProperty(XtraSerializationFlags.DefaultValue)>
Public Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A String value which specifies the time ruler’s caption.

Remarks

The time ruler‘s caption is displayed above the ruler as shown in the image below. If the Caption property is set to the Empty value, no caption is displayed. Captions are often used to indicate a time zone or geographical region whose standard time a ruler displays.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption 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/MainWindow.xaml.cs#L24

rulerUTC.TimeZoneId = TimeZoneInfo.Utc.Id;
rulerUTC.Caption = "UTC";
rulerUTC.TimeMarkerVisibility = DevExpress.XtraScheduler.TimeMarkerVisibility.Never;

synchronizing-with-google-calendar-e502/CS/WebApplication2/Default.aspx.cs#L84

    ruler.TimeZoneId = tzId;
    ruler.Caption = String.Format("Client: {0}", tzId);
}

VB.NET

synchronizing-with-google-calendar-e502/VB/WebApplication2/Default.aspx.vb#L87

    ruler.TimeZoneId = tzId
    ruler.Caption = String.Format("Client: {0}", tzId)
End Sub