Represents Nth occurrence (or all occurrences) of the specified day of the week. More...
Inherits Object.
Public Member Functions | |
int32_t | get_NthOccurrence () const |
Gets the nth occurrence of the day of the week. More... | |
void | set_NthOccurrence (int32_t value) |
Sets the nth occurrence of the day of the week. More... | |
System::DayOfWeek | get_DayOfWeek () const |
Gets the day of the week. More... | |
void | set_DayOfWeek (System::DayOfWeek value) |
Sets the day of the week. More... | |
bool | get_IsAllOccurrences () |
Returns True when NthOccurrence is zero (meaning all occurrences of this day of week). More... | |
ByDay (System::DayOfWeek dayOfWeek) | |
Initializes a new instance of ByDay class. More... | |
ByDay (int32_t nthOccurrence, System::DayOfWeek dayOfWeek) | |
Initializes a new instance of ByDay class. More... | |
bool | Equals (System::SharedPtr< System::Object > obj) override |
Determines whether the specified Object is equal to the current Object. More... | |
int32_t | GetHashCode () const override |
GetHashCode returns a hash function for this object. More... | |
Protected Member Functions | |
virtual bool | Equals_ (System::SharedPtr< ByDay > other) |
Determines whether the specified ByDay is equal to this instance. More... | |
virtual | ~ByDay () |
Represents Nth occurrence (or all occurrences) of the specified day of the week.
Corresponds to one day of the week specified in the BYDAY part of a recurrence rule.
Can be used in a monthly or yearly recurrence rule to specify Nth occurrence (or all occurrences) of the specified day of the week in a month or year.
BYDAY=MO represents all Mondays of the month or year. To represent all occurrences, set NthOccurrence to 0.
BYDAY=2MO represents 2nd Monday in a month or year.
BYDAY=-1MO represents the last Monday of a month or year.
Aspose::Email::Calendar::Recurrences::ByDay::ByDay | ( | System::DayOfWeek | dayOfWeek | ) |
Initializes a new instance of ByDay class.
dayOfWeek | A day of the week. |
Aspose::Email::Calendar::Recurrences::ByDay::ByDay | ( | int32_t | nthOccurrence, |
System::DayOfWeek | dayOfWeek | ||
) |
Initializes a new instance of ByDay class.
nthOccurrence | The nth occurrence of the day of the week. |
dayOfWeek | A day of the week. |
|
protectedvirtual |
|
override |
Determines whether the specified Object is equal to the current Object.
obj | The Object to compare with the current Object. |
|
protectedvirtual |
System::DayOfWeek Aspose::Email::Calendar::Recurrences::ByDay::get_DayOfWeek | ( | ) | const |
Gets the day of the week.
bool Aspose::Email::Calendar::Recurrences::ByDay::get_IsAllOccurrences | ( | ) |
Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).
int32_t Aspose::Email::Calendar::Recurrences::ByDay::get_NthOccurrence | ( | ) | const |
Gets the nth occurrence of the day of the week.
Valid range for this property is from -53 to 53.
Positive values represent Nth occurrence from the beginning of the period, for example NthOccurrence = 1, represents 1st occurrence of the day of the week.
Negative values represent Nth occurrence from the end of the period, for example NthOccurrence = -1, represents last occurrence of the day of the week.
When NthOccurrence is zero, it represents all occurrences of the specified day of the week. For example, BYDAY=MO has NthOccurrence zero and represents all Mondays in the set.
|
override |
GetHashCode returns a hash function for this object.
void Aspose::Email::Calendar::Recurrences::ByDay::set_DayOfWeek | ( | System::DayOfWeek | value | ) |
Sets the day of the week.
void Aspose::Email::Calendar::Recurrences::ByDay::set_NthOccurrence | ( | int32_t | value | ) |
Sets the nth occurrence of the day of the week.
Valid range for this property is from -53 to 53.
Positive values represent Nth occurrence from the beginning of the period, for example NthOccurrence = 1, represents 1st occurrence of the day of the week.
Negative values represent Nth occurrence from the end of the period, for example NthOccurrence = -1, represents last occurrence of the day of the week.
When NthOccurrence is zero, it represents all occurrences of the specified day of the week. For example, BYDAY=MO has NthOccurrence zero and represents all Mondays in the set.