Platforms to show: All Mac Windows Linux Cross-Platform

Back to CalRecurrenceRuleMBS class.

CalRecurrenceRuleMBS.firstDayOfTheWeek as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Calendar MBS MacFrameworks Plugin 7.7 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The first day of the week.

Recurrence patterns can specify which day of the week should be treated as the first day. Possible values for this property are integers 0 and 1-7, which correspond to days of the week with Sunday = 1. Zero indicates that the property is not set for this recurrence. he first day of the week only affects the way the recurrence is expanded for weekly recurrence patterns with an interval greater than 1. For those types of recurrence patterns, the CalendarStore framework will set firstDayOfTheWeek to be 2 (Monday). In all other cases, this property will be set to zero. The iCalendar spec stipulates that the default value is Monday if this property is not set.
(Read only property)

CalRecurrenceRuleMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Calendar MBS MacFrameworks Plugin 7.7 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The internal used CalRecurrenceRule reference.

(Read and Write property)

CalRecurrenceRuleMBS.recurrenceEnd as CalRecurrenceEndMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Calendar MBS MacFrameworks Plugin 7.7 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This property defines when the the repeating event is scheduled to end.

The end date can be specified by a number of occurrences, or with an end date.
Value can be nil.
This is a read only property.
(Read only property)

CalRecurrenceRuleMBS.recurrenceInterval as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Calendar MBS MacFrameworks Plugin 7.7 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Specifies how often the rule repeats over the given recurrence type.

An interval of 1 indicates that the event repeats every time unit, while an interval of 2 indicates that the repetition occurs in every other unit, etc.

This is a read only property.
(Read only property)

CalRecurrenceRuleMBS.recurrenceType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Calendar MBS MacFrameworks Plugin 7.7 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This property designates the unit of time used to describe the recurrence pattern.

CalRecurrenceType designates the unit of time used to describe the recurrence. It has four possible values, which correspond to recurrence rules that are defined in terms of days, weeks, months, and years.

The interval of a CalRecurrenceRule is an Integer which specifies how often the recurrence rule repeats over the unit of time described by the CalRecurrenceType. For example, if the CalRecurrenceType is CalWeeklyRecurrence, then an interval of 1 means the pattern is repeated every week. A NSUInteger of 2 indicates it is repeated every other week, 3 means every third week, and so on. The Integer must be a positive integer; 0 is not a valid value, and nil will be returned if the client attempts to initialize a rule with a negative or zero interval.

Together, CalRecurrenceType and interval define how often the CalRecurrenceRule's pattern repeats.
This is a read only property.
(Read only property)

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...