TimeScale.FormatCaption(DateTime, DateTime) Method

Returns a string formatted according to display format for this scale type.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.1.Core.dll

Declaration

public virtual string FormatCaption(
    DateTime start,
    DateTime end
)
Public Overridable Function FormatCaption(
    start As Date,
    end As Date
) As String

Parameters

Name Type Description
start DateTime

A String value representing a scale starting point.

end DateTime

A String value representing a scale final point.

Returns

Type Description
String

A String value to be used in a timeline caption.

Remarks

To change the default format string for the time scale use the TimeScale.DisplayFormat property.

See Also