The RecurrenceRule type exposes the following members.
Methods
Name | Description | |
---|---|---|
Annually |
Specifies that the event will repeat every year.
| |
Daily()()()() |
Specifies that the event will repeat daily.
| |
Daily(Int32) |
Specifies that the event will repeat every x days.
| |
Decode |
Loads a rule from a string encoded using Encode() method (DataRecurrenceField).
| |
DecodeStart | ||
Encode |
Creates a string representation of the rule that can be stored in the database (DataRecurrenceField).
| |
EncodeExceptionDeleted |
Creates a string representation of a 'Deleted' exception from the rule that can be stored in the database (DataRecurrenceField).
| |
EncodeExceptionModified |
Creates a string representation of a 'Modified' exception from the rule that can be stored in the database (DataRecurrenceField).
| |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FromDateTime |
Creates a new RecurrenceRule from starting DateTime. It prefills certain fields but it's still necessary to specify it further by calling methods like Weekly().
| |
FromJson |
Loads a rule from a JSON string returned by the UI dialog (RecurrentEventEdit.aspx).
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Indefinitely |
The event will repeat indefinitely.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Monthly()()()() |
Specifies that the event will repeat every month.
| |
Monthly(array<Int32>[]()[][]) |
Specifies that the event will repeat every month on certain days of month.
| |
Monthly(array<Int32>[]()[][], Int32) |
Specifies that the event will repeat every x month on certain days of month.
| |
Monthly(array<Int32>[]()[][], array<Int32>[]()[][]) |
Specifies that the event will repeat in certain months on certain days of month.
| |
Prefix |
Returns the recurrence string prefix for this master id.
| |
Times |
How many times it will be repeated.
| |
ToJson()()()() |
Serializes the rule to a JSON string that can be used to fill the UI dialog (RecurrentEventEdit.aspx).
It is only able to serialize a subset of the possible rules that can be loaded by the dialog.
It uses the culture of the current thread.
| |
ToJson(CultureInfo) |
Serializes the rule to a JSON string that can be used to fill the UI dialog (RecurrentEventEdit.aspx).
It is only able to serialize a subset of the possible rules that can be loaded by the dialog.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Until |
What the ending date of the repeat range.
| |
Weekly()()()() |
Specifies that the event will repeat every week.
| |
Weekly(array<DayOfWeek>[]()[][]) |
Specifies that the event will repeat on certain days every week.
| |
Weekly(array<DayOfWeek>[]()[][], Int32) |
Specifies that the event will repeat on certain days every x weeks.
|
Fields
Name | Description | |
---|---|---|
Every |
This event repeats every "x" day/week/month/year.
| |
Exception |
Specifies that this event represents an exception from rule defined in the main event.
| |
Named |
Named days/weeks on which the event repeats. If a value is specified (not null), it will be used instead of Every value.
| |
NoRepeat |
Specifies that the event does not recur.
| |
Repeat |
The type of event repeating (None, Daily, Weekly, etc.).
| |
Units |
List of lower units on which the events repeats (e.g. days of week for Weekly rule).
|
Properties
Name | Description | |
---|---|---|
Id |
ID of the event.
| |
RangeSpec |
Recurrence range definition type (Until, or Times).
| |
Start | ||
TimesValue |
How many times does the event repeat. Applies when RangeSpec = Times.
| |
UntilValue |
End time of the repeat range (excluded). Applies when RangeSpec = Until.
|