Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
Events.RecurrenceRule.FirstDayOfTheWeek
Queries first day of week number.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
Events | 6.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "Events.RecurrenceRule.FirstDayOfTheWeek"; EKRecurrenceRule ) More
Parameters
Parameter | Description | Example |
---|---|---|
EKRecurrenceRule | The reference to the recurrence rule. | $RecurrenceRule |
Result
Returns number or error.
Description
Queries first day of week number.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. The 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 Calendar 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.
See also
- Events.RecurrenceDayOfWeek.DayOfTheWeek
- Events.RecurrenceRule.DaysOfTheWeek
- Events.RecurrenceRule.DaysOfTheYear
- Events.RecurrenceRule.MonthsOfTheYear
This function checks for a license.
Created 10th March 2016, last changed 13th March 2016
Events.RecurrenceRule.Description - Events.RecurrenceRule.Frequency