cxGetRecurrenceDescriptionString(TcxSchedulerEventRecurrenceInfo,Boolean) Method

Returns the user event‘s recurring information as a string.

Declaration

function cxGetRecurrenceDescriptionString(ARecurrenceInfo: TcxSchedulerEventRecurrenceInfo; AFullDescription: Boolean = False): string;

Parameters

Name	Type
ARecurrenceInfo	TcxSchedulerEventRecurrenceInfo
AFullDescription	Boolean

Returns

Type
string

Remarks

The TcxSchedulerEventRecurrenceInfo class represents recurring information for the specified user event, provided that the user event is recurring. For example, if the recurring user event was scheduled to the 03/18/2005, from 4 pm through to 5 pm, with the default recurrence options (the default options in the Event recurrence dialog), then the resulting string will be ‘every Friday from 16:00 to 17:00’.

Use the cxGetRecurrenceDescriptionString function to retrieve data on the user event‘s recurrence as a string.

Note

if the specified user event is not recurring then an empty string will be returned.

If you need to display any information (not default) in the Event recurrence dialog, implement an appropriate routine and bind it to the application by using the cxGetRecurrenceDescriptionStringProc constant.