Back to Devexpress

TimeScale.FormatCaption(DateTime, DateTime) Method

corelibraries-devexpress-dot-xtrascheduler-dot-timescale-dot-formatcaption-x28-system-dot-datetime-system-dot-datetime-x29.md

latest2.0 KB
Original Source

TimeScale.FormatCaption(DateTime, DateTime) Method

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

Namespace : DevExpress.XtraScheduler

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

NuGet Package : DevExpress.Scheduler.Core

Declaration

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

Parameters

NameTypeDescription
startDateTime

A String value representing a scale starting point.

| | end | DateTime |

A String value representing a scale final point.

|

Returns

TypeDescription
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

Time Scales

TimeScale Class

TimeScale Members

DevExpress.XtraScheduler Namespace