TdxRangeControlDateTimeScale.GetDisplayText(TDateTime,Integer) Method

Creates a specifically formatted text label for the date/time scale from the specified TDateTime value.

Declaration

function GetDisplayText(const ADate: TDateTime; AFormatId: Integer): string; virtual;

Parameters

Name	Type
ADate	TDateTime
AFormatId	Integer

Returns

Type
string

Remarks

Normally, this function supports the internal infrastructure and is not intended to be used directly from your code. The GetDisplayText function is called internally by the range control in order to format scale headers in the case of the active Date/Time Header or Scheduler data range selection and visualization model.

The virtual GetDisplayText function passes the ADate value as the GetDefaultDisplayText function parameter and does not use the AFormatId parameter employed in the GetDisplayText function provided by the TdxRangeControlPredefinedDateHeaderScale class (i.e., the TdxRangeControlDateTimeScale class descendant).

If you are implementing a custom Date/Time scale, you may need to override the GetDisplayText function in a TdxRangeControlDateTimeScale descendant.