Aspose::Email::Calendar::Recurrences::ByDayCollection Class Reference

Represents a collection of ByDay objects. More...

Inherits System::Collections::ObjectModel::Collection< System::SharedPtr< Aspose::Email::Calendar::Recurrences::ByDay > >.

Public Member Functions

 ByDayCollection ()
 
 ByDayCollection (System::SharedPtr< ByDayCollection > collection)
 
int32_t Add (System::SharedPtr< ByDay > byDay)
 Adds a ByDay to the collection. More...
 
int32_t Add (System::DayOfWeek dayOfWeek)
 Creates and adds a ByDay that represents all occurrences of the day of the week to the collection. More...
 
int32_t Add (int32_t nthOccurrence, System::DayOfWeek dayOfWeek)
 Creates and adds a ByDay to the collection. More...
 
bool Contains (System::SharedPtr< ByDay > element, int32_t maxNthOccurrence)
 Not really sure what this does, need to find out and document. More...
 
bool Contains (System::DayOfWeek const &dayOfWeek)
 Returns a value indicating whether a specified day of week is present in the collection. More...
 
virtual bool Equals (System::SharedPtr< ByDayCollection > other)
 Determines whether the specified ByDayCollection is equal to this instance. 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...
 
void SetTemplateWeakPtr (uint32_t argument) override
 

Protected Member Functions

virtual ~ByDayCollection ()
 

Friends

class Aspose::Email::Calendar::Recurrences::RecurrenceRule
 

Detailed Description

Represents a collection of ByDay objects.

Corresponds to the BYDAY part of the recurrence rule.

The BYDAY rule specifies a list of days of the week for a monthly or yearly recurrence rule.

For each day of the week, a specific Nth occurrence or all occurrences can be specified.

Constructor & Destructor Documentation

◆ ByDayCollection() [1/2]

Aspose::Email::Calendar::Recurrences::ByDayCollection::ByDayCollection ( )

◆ ByDayCollection() [2/2]

Aspose::Email::Calendar::Recurrences::ByDayCollection::ByDayCollection ( System::SharedPtr< ByDayCollection collection)

◆ ~ByDayCollection()

virtual Aspose::Email::Calendar::Recurrences::ByDayCollection::~ByDayCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/3]

int32_t Aspose::Email::Calendar::Recurrences::ByDayCollection::Add ( int32_t  nthOccurrence,
System::DayOfWeek  dayOfWeek 
)

Creates and adds a ByDay to the collection.

Parameters
nthOccurrenceThe nth occurrence of the day of the week.
dayOfWeekA day of the week.
Returns
The zero-based index of the newly added item.

◆ Add() [2/3]

int32_t Aspose::Email::Calendar::Recurrences::ByDayCollection::Add ( System::DayOfWeek  dayOfWeek)

Creates and adds a ByDay that represents all occurrences of the day of the week to the collection.

Parameters
dayOfWeekA day of the week.
Returns
The zero-based index of the newly added item.

◆ Add() [3/3]

int32_t Aspose::Email::Calendar::Recurrences::ByDayCollection::Add ( System::SharedPtr< ByDay byDay)

Adds a ByDay to the collection.

Parameters
byDayThe item to add to the collection.
Returns
The zero-based index of the newly added item.

◆ Contains() [1/2]

bool Aspose::Email::Calendar::Recurrences::ByDayCollection::Contains ( System::DayOfWeek const &  dayOfWeek)

Returns a value indicating whether a specified day of week is present in the collection.

Parameters
dayOfWeekDay of weekSystem::DayOfWeek.
Returns
True if the value parameter exists within this collection, otherwise false.

◆ Contains() [2/2]

bool Aspose::Email::Calendar::Recurrences::ByDayCollection::Contains ( System::SharedPtr< ByDay element,
int32_t  maxNthOccurrence 
)

Not really sure what this does, need to find out and document.

◆ Equals() [1/2]

virtual bool Aspose::Email::Calendar::Recurrences::ByDayCollection::Equals ( System::SharedPtr< ByDayCollection other)
virtual

Determines whether the specified ByDayCollection is equal to this instance.

Parameters
otherThe ByDayCollection to compare with this instance.
Returns
true if the specified ByDayCollection is equal to this instance; otherwise, false.

◆ Equals() [2/2]

bool Aspose::Email::Calendar::Recurrences::ByDayCollection::Equals ( System::SharedPtr< System::Object >  obj)
override

Determines whether the specified Object is equal to the current Object.

Parameters
objThe Object to compare with the current Object.
Returns
Returns a boolean indicating if the passed in object obj is Equal to this.

◆ GetHashCode()

int32_t Aspose::Email::Calendar::Recurrences::ByDayCollection::GetHashCode ( ) const
override

GetHashCode returns a hash function for this object.

Returns
Returns a hash function for this object.

◆ SetTemplateWeakPtr()

void Aspose::Email::Calendar::Recurrences::ByDayCollection::SetTemplateWeakPtr ( uint32_t  argument)
override

Friends And Related Function Documentation

◆ Aspose::Email::Calendar::Recurrences::RecurrenceRule