Aspose::Email::Calendar::CalendarReader Class Reference

Allows read the calendar with multi events to the Appointment object from a file or stream. More...

Inherits Object.

Public Member Functions
System::SharedPtr< Appointment >	get_Current () const
	Current read event. More...
System::String	get_Version () const
	Gets the Version of calendar. More...
int32_t	get_Count ()
	Gets the number of Vevent components. More...
bool	get_IsMultiEvents ()
	Gets whether calendar contains multi events. More...
AppointmentMethodType	get_Method () const
	Gets the iCalendar object method type associated with the calendar object. More...
	CalendarReader (System::String path)
	Initializes a new instance of CalendarReader with source file and default Appointment LoadOptions. More...
	CalendarReader (System::String path, System::SharedPtr< AppointmentLoadOptions > options)
	Initializes a new instance of CalendarReader with source file and Appointment LoadOptions. More...
	CalendarReader (System::SharedPtr< System::IO::Stream > stream)
	Initializes a new instance of CalendarReader with source stream and default Appointment LoadOptions. More...
	CalendarReader (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< AppointmentLoadOptions > options)
	Initializes a new instance of CalendarReader with source stream and Appointment LoadOptions. More...
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< Appointment > > >	LoadAsMultiple ()
	Loads a list of events from a calendar with multiple events. More...
bool	NextEvent ()
	Reads next Event from source and save it to the Current. More...

Detailed Description

Allows read the calendar with multi events to the Appointment object from a file or stream.

Constructor & Destructor Documentation

CalendarReader() [1/4]

Aspose::Email::Calendar::CalendarReader::CalendarReader

(

System::String

path

)

Initializes a new instance of CalendarReader with source file and default Appointment LoadOptions.

Parameters

path	Path to source file.

CalendarReader() [2/4]

Aspose::Email::Calendar::CalendarReader::CalendarReader	(	System::String	path,
		System::SharedPtr< AppointmentLoadOptions >	options
	)

Initializes a new instance of CalendarReader with source file and Appointment LoadOptions.

Parameters

path	Path to source file.
options	Additional LoadOptions.

CalendarReader() [3/4]

Aspose::Email::Calendar::CalendarReader::CalendarReader

(

System::SharedPtr< System::IO::Stream >

stream

)

Initializes a new instance of CalendarReader with source stream and default Appointment LoadOptions.

Parameters

stream

Source stream.

CalendarReader() [4/4]

Aspose::Email::Calendar::CalendarReader::CalendarReader	(	System::SharedPtr< System::IO::Stream >	stream,
		System::SharedPtr< AppointmentLoadOptions >	options
	)

Initializes a new instance of CalendarReader with source stream and Appointment LoadOptions.

Parameters

stream	Source stream.
options	Additional LoadOptions.

Member Function Documentation

get_Count()

int32_t Aspose::Email::Calendar::CalendarReader::get_Count

(

)

Gets the number of Vevent components.

get_Current()

System::SharedPtr<Appointment> Aspose::Email::Calendar::CalendarReader::get_Current

(

)

const

Current read event.

get_IsMultiEvents()

bool Aspose::Email::Calendar::CalendarReader::get_IsMultiEvents

(

)

Gets whether calendar contains multi events.

get_Method()

AppointmentMethodType Aspose::Email::Calendar::CalendarReader::get_Method

(

)

const

Gets the iCalendar object method type associated with the calendar object.

get_Version()

System::String Aspose::Email::Calendar::CalendarReader::get_Version

(

)

const

Gets the Version of calendar.

LoadAsMultiple()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<Appointment> > > Aspose::Email::Calendar::CalendarReader::LoadAsMultiple

(

)

Loads a list of events from a calendar with multiple events.

Returns

NextEvent()

bool Aspose::Email::Calendar::CalendarReader::NextEvent

(

)

Reads next Event from source and save it to the Current.

Returns

True if success otherwise false.