TTimeEdit.UsedTimeAMString function

Declaration

function UsedTimeAMString: string

Function result

Suffix used for an ante meridiem (before midday) time value when 12-hour clock values are used in time TimeFormat.

Description

UsedTimeAMString is a String function which returns the suffix used for an ante meridiem time value when the UsedTimeFormat for the control displays 12-hour clock values. UsedTimeAMString examines the lowercase value returned from UsedTimeFormat to determine whether the value 'ampm' is used in the effective TimeFormat for the control.

If UsedTimeFormat contains 'ampm', the return value is set to the effective display value for a Time which occurs before midday / noon. This is the value from DefaultFormatSettings.TimeAMString when TimeAMString is empty, or the TimeAMString property value when assigned. The default value in the DEFAULT_TIMEAMSTRING constant is used when the return value is unassigned (an empty string).

UsedTimeAMString, along with UsedTimePMString and UsedTimeFormat, are used when a popup is displayed for the Time value in the control.

See UsedTimePMString for the effective value used for a post meridiem (after midday) time value when a 12-hour clock is used.

See also

• TimeFormat
• UsedTimeFormat
• UsedTimePMString
• DefaultFormatSettings