The main class, represents an iCalendar recurrence. More...

Inherits IEquatable< System::SharedPtr< Aspose::Email::Calendar::Recurrences::CalendarRecurrence > >.

Public Member Functions
System::DateTime	get_StartDate () const
	Gets the start date. More...

void	set_StartDate (System::DateTime value)
	Sets the start date. More...

System::DateTime	get_EndDate () const
	Gets the end date. More...

void	set_EndDate (System::DateTime value)
	Sets the end date. More...

System::SharedPtr< RecurrenceRuleCollection >	get_RRules ()
	Gets the R rules. More...

System::SharedPtr< RecurrenceRuleCollection >	get_ExRules ()
	Gets the ex rules. More...

System::SharedPtr< DateCollection >	get_RDates ()
	Gets the R dates. More...

System::SharedPtr< DateCollection >	get_ExDates ()
	Gets the ex dates. More...

	CalendarRecurrence ()
	Initializes a new instance of the CalendarRecurrence class. More...

	CalendarRecurrence (System::String pattern)
	Initializes a new instance of the CalendarRecurrence class. More...

System::SharedPtr< DateCollection >	GenerateOccurrences ()
	Generates the occurrences. More...

System::SharedPtr< DateCollection >	GenerateOccurrencesInternal ()
	Generates occurrences without Evaluation limitation.Use this method for internal calculation to avoid incorrect results. More...

System::SharedPtr< DateCollection >	GenerateOccurrences (int32_t nNextOccurrences)
	Generates n next occurrences. More...

System::SharedPtr< DateCollection >	GenerateOccurrencesInternal (int32_t nNextOccurrences)
	Generates n next occurrences without Evaluation limitation.Use this method for internal calculation to avoid incorrect results. More...

System::SharedPtr< DateCollection >	GenerateOccurrences (System::DateTime rangeStart, System::DateTime rangeEnd)
	Generates the occurrences. More...

System::SharedPtr< DateCollection >	GenerateOccurrences (System::DateTime rangeEnd)

System::SharedPtr< DateCollection >	GenerateOccurrences (System::DateTime rangeStart, System::DateTime rangeEnd, int32_t nNextOccurrences)
	Generates n next occurrences. More...

System::String	ToiCalendar ()
	To iCalendar string. More...

bool	Equals (System::SharedPtr< CalendarRecurrence > other) override
	Determines whether the specified CalendarRecurrence 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
	Returns a hash code for this instance. More...

Static Public Member Functions
static System::SharedPtr< CalendarRecurrence >	FromiCalendar (System::String pattern)
	Gets a recurrence pattern from iCalendar string. More...

static System::SharedPtr< CalendarRecurrence >	FromRecurrence (System::String xmlString)
	Gets a recurrence pattern from XML pattern string. More...

static System::SharedPtr< CalendarRecurrence >	FromRecurrence (System::SharedPtr< System::Xml::XmlElement > xmlElement)
	Gets a recurrence pattern from XmlElement. More...

Static Public Attributes
static System::DateTime	MaxEvaluationRangeEnd

Protected Member Functions
virtual	~CalendarRecurrence ()

Friends
class	Aspose::Email::Mapi::MapiTask

class	Aspose::Email::Mapi::MapiCalendar

class	Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory

bool	operator== (System::SharedPtr< CalendarRecurrence > left, System::SharedPtr< CalendarRecurrence > right)

bool	operator!= (System::SharedPtr< CalendarRecurrence > left, System::SharedPtr< CalendarRecurrence > right)

Detailed Description

The main class, represents an iCalendar recurrence.

Constructor & Destructor Documentation

◆ CalendarRecurrence() [1/2]

Aspose::Email::Calendar::Recurrences::CalendarRecurrence::CalendarRecurrence ( )

Initializes a new instance of the CalendarRecurrence class.

◆ CalendarRecurrence() [2/2]

Aspose::Email::Calendar::Recurrences::CalendarRecurrence::CalendarRecurrence ( System::String pattern )

Initializes a new instance of the CalendarRecurrence class.

Parameters

pattern The pattern.

◆ ~CalendarRecurrence()

virtual Aspose::Email::Calendar::Recurrences::CalendarRecurrence::~CalendarRecurrence ( )

protectedvirtual

Member Function Documentation

◆ Equals() [1/2]

bool Aspose::Email::Calendar::Recurrences::CalendarRecurrence::Equals ( System::SharedPtr< CalendarRecurrence > other )

override

Determines whether the specified CalendarRecurrence is equal to this instance.

Parameters

other The CalendarRecurrence to compare with this instance.

Returns: true if the specified CalendarRecurrence is equal to this instance; otherwise, false.

◆ Equals() [2/2]

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

override

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

Parameters

obj	The Object to compare with the current Object.

Returns: Returns a boolean indicating if the passed in object obj is Equal to this.

◆ FromiCalendar()

static System::SharedPtr<CalendarRecurrence> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::FromiCalendar ( System::String pattern )

static

Gets a recurrence pattern from iCalendar string.

Parameters

pattern StringSystem::String representation of iCalendar.

Returns: Recurrence patternCalendarRecurrence.

◆ FromRecurrence() [1/2]

static System::SharedPtr<CalendarRecurrence> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::FromRecurrence ( System::SharedPtr< System::Xml::XmlElement > xmlElement )

static

Gets a recurrence pattern from XmlElement.

Parameters

xmlElement XmlElementSystem::Xml::XmlElement of pattern.

Returns: Recurrence patternCalendarRecurrence.

◆ FromRecurrence() [2/2]

static System::SharedPtr<CalendarRecurrence> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::FromRecurrence ( System::String xmlString )

static

Gets a recurrence pattern from XML pattern string.

Parameters

xmlString XML stringSystem::String of pattern.

Returns: Recurrence patternCalendarRecurrence.

◆ GenerateOccurrences() [1/5]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrences ( )

Generates the occurrences.

Returns: Collection of datesDateCollection.

Exceptions

Exception throws if StartDate is not set.

◆ GenerateOccurrences() [2/5]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrences ( int32_t nNextOccurrences )

Generates n next occurrences.

Parameters

nNextOccurrences The amount of needed occurrences.

Returns: Collection of datesDateCollection.

Exceptions

Exception	throws if StartDate is not set.
ArgumentOutOfRangeException	throws if amount of needed occurrences is less or equal zero.

◆ GenerateOccurrences() [3/5]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrences ( System::DateTime rangeEnd )

◆ GenerateOccurrences() [4/5]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrences	(	System::DateTime	rangeStart,
		System::DateTime	rangeEnd
	)

Generates the occurrences.

Parameters

rangeStart	The range start.
rangeEnd	The range end.

Returns: Collection of datesDateCollection.

Exceptions

Exception throws if StartDate is not set

◆ GenerateOccurrences() [5/5]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrences	(	System::DateTime	rangeStart,
		System::DateTime	rangeEnd,
		int32_t	nNextOccurrences
	)

Generates n next occurrences.

Parameters

rangeStart	The range start.
rangeEnd	The range end.
nNextOccurrences	The amount of needed occurrences.

Returns: Collection of datesDateCollection.

Exceptions

Exception	throws if StartDate is not set.
ArgumentOutOfRangeException	throws if amount of needed occurrences is less or equal zero.

◆ GenerateOccurrencesInternal() [1/2]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrencesInternal ( )

Generates occurrences without Evaluation limitation.Use this method for internal calculation to avoid incorrect results.

Returns: Collection of datesDateCollection.

Exceptions

Exception throws if StartDate is not set.

◆ GenerateOccurrencesInternal() [2/2]

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GenerateOccurrencesInternal ( int32_t nNextOccurrences )

Generates n next occurrences without Evaluation limitation.Use this method for internal calculation to avoid incorrect results.

Parameters

nNextOccurrences The amount of needed occurrences.

Returns: Collection of datesDateCollection.

Exceptions

Exception	throws if StartDate is not set.
ArgumentOutOfRangeException	throws if amount of needed occurrences is less or equal zero.

◆ get_EndDate()

System::DateTime Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_EndDate ( ) const

Gets the end date.

The end date.

◆ get_ExDates()

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_ExDates ( )

Gets the ex dates.

The ex dates.

◆ get_ExRules()

System::SharedPtr<RecurrenceRuleCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_ExRules ( )

Gets the ex rules.

The ex rules.

◆ get_RDates()

System::SharedPtr<DateCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_RDates ( )

Gets the R dates.

The R dates.

◆ get_RRules()

System::SharedPtr<RecurrenceRuleCollection> Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_RRules ( )

Gets the R rules.

The R rules.

◆ get_StartDate()

System::DateTime Aspose::Email::Calendar::Recurrences::CalendarRecurrence::get_StartDate ( ) const

Gets the start date.

The start date.

◆ GetHashCode()

int32_t Aspose::Email::Calendar::Recurrences::CalendarRecurrence::GetHashCode ( ) const

override

Returns a hash code for this instance.

Returns: A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

◆ set_EndDate()

void Aspose::Email::Calendar::Recurrences::CalendarRecurrence::set_EndDate ( System::DateTime value )

Sets the end date.

The end date.

◆ set_StartDate()

void Aspose::Email::Calendar::Recurrences::CalendarRecurrence::set_StartDate ( System::DateTime value )

Sets the start date.

The start date.

◆ ToiCalendar()

System::String Aspose::Email::Calendar::Recurrences::CalendarRecurrence::ToiCalendar ( )

To iCalendar string.

Returns: StringSystem::String representation of RecurrencePattern.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiCalendar

friend class Aspose::Email::Mapi::MapiCalendar

friend

◆ Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory

friend class Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory

friend

◆ Aspose::Email::Mapi::MapiTask

friend class Aspose::Email::Mapi::MapiTask

friend

◆ operator!=

bool operator!=	(	System::SharedPtr< CalendarRecurrence >	left,
		System::SharedPtr< CalendarRecurrence >	right
	)

friend

◆ operator==

bool operator==	(	System::SharedPtr< CalendarRecurrence >	left,
		System::SharedPtr< CalendarRecurrence >	right
	)

friend

Member Data Documentation

◆ MaxEvaluationRangeEnd

System::DateTime Aspose::Email::Calendar::Recurrences::CalendarRecurrence::MaxEvaluationRangeEnd

static

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CalendarRecurrence() [1/2]

◆ CalendarRecurrence() [2/2]

◆ ~CalendarRecurrence()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ FromiCalendar()

◆ FromRecurrence() [1/2]

◆ FromRecurrence() [2/2]

◆ GenerateOccurrences() [1/5]

◆ GenerateOccurrences() [2/5]

◆ GenerateOccurrences() [3/5]

◆ GenerateOccurrences() [4/5]

◆ GenerateOccurrences() [5/5]

◆ GenerateOccurrencesInternal() [1/2]

◆ GenerateOccurrencesInternal() [2/2]

◆ get_EndDate()

◆ get_ExDates()

◆ get_ExRules()

◆ get_RDates()

◆ get_RRules()

◆ get_StartDate()

◆ GetHashCode()

◆ set_EndDate()

◆ set_StartDate()

◆ ToiCalendar()

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiCalendar

◆ Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory

◆ Aspose::Email::Mapi::MapiTask

◆ operator!=

◆ operator==

Member Data Documentation

◆ MaxEvaluationRangeEnd