HeaderCaptionService.GetTimeScaleHeaderCaption(TimeScaleHeader) Method

Override this method to return a format string for displaying the TimeScale header caption in a Timescale View.

Namespace: DevExpress.XtraScheduler.Services.Implementation

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public string GetTimeScaleHeaderCaption(
    TimeScaleHeader header
)

VB.NET

Public Function GetTimeScaleHeaderCaption(
    header As TimeScaleHeader
) As String

Parameters

Name	Type	Description
header	DevExpress.XtraScheduler.Drawing.TimeScaleHeader	A DevExpress.XtraScheduler.Drawing.TimeScaleHeader object, representing a header.

Returns

Type	Description
String	A format string.

Remarks

The following picture illustrates the TimeScaleHeader location. The GetTimeScaleHeaderCaption override has been used to change the caption for the interval containing January 1.

For information on using the HeaderCaptionService refer to the How to: Display Custom Day Headers topic and the online example Formatting Services - an example of use.

Implements

GetTimeScaleHeaderCaption(TimeScaleHeader)