Class RecurrenceRule
RecurrenceRule class
Represents one recurrence or exception rule in a recurrence pattern.
public class RecurrenceRule
Constructors
| Name | Description |
|---|---|
| RecurrenceRule() | Initializes a new instance of the RecurrenceRule class. |
Properties
| Name | Description |
|---|---|
| ByDay { get; } | Gets the by day. |
| ByHour { get; } | Gets the by hour. |
| ByMinute { get; } | Gets the by minute. |
| ByMonth { get; } | Gets the by month. |
| ByMonthDay { get; } | Gets the by month day. |
| BySecond { get; } | Gets the by second. |
| BySetPos { get; } | Gets the by set pos. |
| ByWeekNo { get; } | Gets the by week no. |
| ByYearDay { get; } | Gets the by year day. |
| Count { get; set; } | Gets or sets the count. |
| EndType { get; set; } | Gets or sets the end type. |
| Frequency { get; set; } | Gets or sets the type of the recurrence rule. |
| FriendlyText { get; } | Gets user friendly text of rule. |
| Interval { get; set; } | Gets or sets the interval. |
| Until { get; set; } | Gets or sets the until. |
| WeekStart { get; set; } | Gets or sets the starting day of the week. |
Remarks
Corresponds to RRULE or EXRULE part in iCalendar.
To construct a recurrence rule, you typically need to:
Specify the type of the rule in
Frequency.Specify how the recurrence pattern ends using
EndType,CountorUntil.Specify values in one or more ByXXX collections.
Note, that if ByXXX rule part values are found which are beyond the available scope (ie, BYMONTHDAY=30 in February), they are simply ignored.
Information, not contained in the rule, necessary to determine the various recurrence instance start time and dates are derived from StartDate. For example, “FREQ=YEARLY;BYMONTH=1” doesn’t specify a specific day within the month or a time. This information would be the same as what is specified for DTSTART.
ByXXX rule parts modify the recurrence in some manner. ByXXX rule parts for a period of time which is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, “FREQ=DAILY;BYMONTH=1” reduces the number of recurrence instances from all days (if BYMONTH tag is not present) to all days in January. ByXXX rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, “FREQ=YEARLY;BYMONTH=1,2” increases the number of days within the yearly recurrence set from 1 (if BYMONTH tag is not present) to 2.
If multiple ByXXX rule parts are specified, then after evaluating the specified Frequency and Interval rule parts, the ByXXX rule parts are applied to the current set of evaluated occurrences in the following order: ByMonth, ByWeekNo, ByYearDay, ByMonthDay, ByDay, ByHour, ByMinute, BySecond and BySetPos; then Count and Until are evaluated.
See Also
- namespace Aspose.Email.Calendar.Recurrences
- assembly Aspose.Email
