[]
        
(Showing Draft Content)

C1.Schedule.RecurrencePattern

RecurrencePattern Class

The RecurrencePattern class contains information that describes the recurrence pattern and range of the associated Appointment object.

Inheritance
RecurrencePattern
Namespace: C1.Schedule
Assembly: C1.ScheduleCore.dll
Syntax
public class RecurrencePattern : INotifyPropertyChanged, ISerializable

Constructors

Name Description
RecurrencePattern(SerializationInfo, StreamingContext)

Special constructor for deserialization.

Properties

Name Description
DayOfMonth

Gets or sets the number of the day in its respective month on which each occurrence will occur. Applicable only when the RecurrenceType property is set to Monthly or Yearly. The default value is 1.

DayOfWeekMask

Gets or sets the WeekDaysEnum value representing the mask for week days on which the recurring appointment occurs. Monthly and yearly patterns are only valid for a single day. Weekly patterns are only valid as the Or of the DayOfWeekMask. The default value is 0.

Description

Gets the human-readable description of the RecurrencePattern object.

Duration

Gets or sets the TimeSpan value indicating the duration of each occurrence in the recurrence pattern.

EndTime

Gets or sets the DateTime value indicating the end time for the given occurrence of the recurrence pattern.

Exceptions

Gets the AppointmentList object which holds the list of Appointment objects that define the exceptions to that series of appointments. Appointment objects are added to the Exceptions whenever a property in the corresponding Appointment object is altered.

Info

Gets or sets the CalendarInfo defining calendar settings.

Instance

Get or sets the WeekOfMonthEnum value specifying the count for which the recurrence pattern is valid for a given interval. This property is only valid for recurrences of the MonthlyNth and YearlyNth types and allows the definition of a recurrence pattern that is only valid for the Nth occurrence, such as "the 2nd Sunday in March" pattern. The default value is WeekOfMonthEnum.First.

Interval

Gets or sets the int value specifying the interval between occurrences of the recurrence. The Interval property works in conjunction with the RecurrenceType property to determine the cycle of the recurrence. The maximum allowable value is 99 for weekly patterns and 999 for daily patterns. The default value is 1.

MonthOfYear

Gets or sets the value indicating which month of the year is valid for the specified recurrence pattern. Can be a number from 1 to 12. This property is only valid for recurrence patterns whose RecurrenceType property is set to YearlyNth or Yearly. The default value is 1.

NoEndDate

Gets or sets the bool value indicating if the recurrence pattern is endless. The default value is True.

Occurrences

Gets or sets the number of occurrences for the recurrence pattern. This property allows the definition of a recurrence pattern that is only valid for the specified number of subsequent occurrences. For example, you can set this property to 10 for a formal training course that will be held on the next ten Thursday evenings. The default value is 0.

ParentAppointment

Gets the Appointment object which represents the master appointment for this RecurrencePattern object.

PatternEndDate

Gets or sets the DateTime value indicating the end date of the recurrence pattern.

PatternStartDate

Gets or sets the DateTime value indicating the start date of the recurrence pattern.

RecurrenceType

Gets or sets the RecurrenceTypeEnum value determining the type of recurrence (daily, monthly, etc.). Default value is RecurrenceTypeEnum.Weekly.

RemovedOccurrences

Gets the AppointmentList object which holds the list of Appointment objects removed from that series of appointments.

StartTime

Gets or sets the DateTime value indicating the start time for the given occurrence of the recurrence pattern.

Methods

Name Description
GetDaysOfWeek()

Converts the DayOfWeekMask property into the list of DayOfWeek constants.

GetDescription(CalendarInfo)

Gets the human-readable description of the RecurrencePattern object according to the specified CalendarInfo object. Use this method instead of Description property if the RecurrencePattern object does not belong to any C1Schedule control.

GetDescription(CultureInfo)

Gets the human-readable description of the RecurrencePattern object according to the specified culture.

OnPropertyChanged(string)
SetDirty()

Specifies that the current recurrence pattern has been changed and should invalidate properties.

SetDirty(bool)

Specifies that the current recurrence pattern has been changed and should invalidate properties.