TdxRangeControlDateTimeAutoFormatHelper.FormatWeek(TDateTime,Integer) Method

Returns the specified date/time value formatted as a Unicode string ready to display as the corresponding header of the scale graduated in weeks.

Declaration

class function FormatWeek(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 FormatWeek class function is called internally by the GetDisplayText function of a predefined header scale, provided that the scale is graduated in weeks.

The ADate and AFormatId parameters are used to pass the date/time value that needs to be formatted and the required format index in the list of formatting variants supported by the scale graduated in weeks. To identify the number of supported variants, call the GetFormatCount class function passing rcduWeek as the AScaleUnit parameter value.