TTMSFNCRecurrencyHandler Class
Parses, composes, and expands recurrence rules into concrete date ranges.
API unit family: TMSFNCRecurrencyHandler
Inherits from: TObject
Syntax
TTMSFNCRecurrencyHandler = class(TObject)
Properties
| Name | Description |
|---|---|
| Dates | Generated recurrence date ranges. |
| DayNum | Ordinal occurrence number for a weekday index. |
| Days | Selected days of the week used when composing or expanding day-based recurrence rules. |
| EndTime | End date and time of the base occurrence. |
| ExDates | Exception date ranges removed from the generated recurrence dates. |
| Frequency | Recurrence frequency used to advance occurrences. |
| Interval | Interval multiplier applied to the recurrence frequency. |
| Months | Month numbers used by BYMONTH recurrence rule parts. |
| Recurrency | Recurrence rule string that is parsed or generated by the handler. |
| RepeatCount | Maximum number of generated occurrences. |
| RepeatUntil | End date used to stop recurrence generation. |
| StartTime | Start date and time of the base occurrence. |
| TimeSpan | Optional maximum time span used to limit generated recurrence dates. |
Methods
| Name | Description |
|---|---|
| Compose | Builds a recurrence rule string from the current handler settings. |
| DatesAsStrings | Creates a string list that describes each generated date range. |
| Generate | Generates the concrete recurrence date ranges from the current start, end, and rule settings. |
| IsRecurrent | Checks whether generation produced more than one date range. |
| NextDate | Returns the next generated date range and advances the internal iterator. |
| Parse | Parses the recurrence rule string and updates the handler fields used for generation. |
| RecurrentMaxDate | Returns the latest end date in the generated recurrence range. |
| RecurrentMinDate | Returns the earliest date represented by the current recurrence settings. |