Event Class

Represents event calendar entity.

Inheritance Hierarchy

SystemObject
Limilabs.Mail.PDIBasePdiEntity
Limilabs.Mail.AppointmentsEvent

Namespace: Limilabs.Mail.Appointments
Assembly: Mail (in Mail.dll) Version: 3.0.23341.1754

Syntax

C++

Copy

[SerializableAttribute]
public class Event : BasePdiEntity

<SerializableAttribute>
Public Class Event
	Inherits BasePdiEntity

[SerializableAttribute]
public ref class Event : public BasePdiEntity

[<SerializableAttribute>]
type Event =  
    class
        inherit BasePdiEntity
    end

The Event type exposes the following members.

Constructors

	Name	Description
	Event	Creates new event entity.

Top

Properties

	Name	Description
	Alarm	Gets first alarm from the Alarms list or if there are no alarms for this event.
	Alarms	List of alarms for this event.
	Class	Gets or sets class of this event (public, private, confidential).
	Description	Gets or sets description of this event. In Microsoft Outlook, the DESCRIPTION corresponds to the descriptive text below "Appointment" form.
	DescriptionAltRep	Gets or set ALTREP parameter of Description header. It specifies a URI that points to analternate representation for a textual property value (e.g "CID:part3.msg.970415T083000@example.com").
	End	Gets or sets end time of this event ("DTEND").
	EndTimeZoneId	Gets or sets time zone id of End time of this event. Consider using method instead setting this property.
	ExceptionDates	Gets a list of date/time exceptions for this event. (EXDATE).
	ExceptionsTimeZoneId	Gets or sets time zone id of ExceptionDates of this event. Consider using method instead setting this property.
	Location	Gets or sets location of this event.
	Organizer	Gets or sets the organizer of this event. Use SetOrganizer(Person) method to set organizer.
	Participants	Gets all participants of this event. Use AddParticipant(Participant) method to add new participant to this collection.
	Priority	Gets or sets priority of this event.
	RecurrenceId	Gets recurence id this instants represents. (RECURRENCE-ID).
	RecurringRules	Gets all recurring rules for this event. Use AddRecurringRule method to add new participant to this collection.
	Sequence	Gets or sets sequence of this event. You should increment this number for each event update. First update should have sequence set to 1.
	Stamp	Gets or sets time stamp of this event (Always converted to UTC format).
	Start	Gets or sets start time of this event ("DTSTART").
	StartTimeZoneId	Gets or sets time zone id of Start time of this event. Consider using method instead setting this property.
	Status	Gets or sets status of this event (tentative, confirmed, canceled).
	Summary	Gets or sets summery of this event. In Microsoft Outlook, the SUMMARY corresponds to the "Subject" entry in the "Appointment" form.
	UID	Gets or sets the unique id of this event. For sending an UPDATE for an event the UID should match the original UID. Also Sequence should be set.
	XAltDescription	Gets or sets the value of X-ALT-DESC. It is used by Outlook to specify HTML version of Description header.

Top

Methods

	Name	Description
	Accept	Sets Status to Accepted for participants with specified email. Removes all others from the event.
	AddAlarm	Creates new alarm and adds it to the Alarms collection of this event.
	AddAlarm(Alarm)	Adds alarm to the Alarms collection of this event.
	AddCustomHeader	Adds custom header to this entity. (Inherited from BasePdiEntity.)
	AddParticipant	Adds new participant to this event.
	AddRecurringRule	Creates new recurring rule and adds it to the RecurringRules collection of this event.
	AddRecurringRule(RecurringRule)	Adds recurring rule to the RecurringRules collection of this event.
	AllDay	Marks the event as an all day event. Time in Start and End properties will be ignored if this method is used.
	Cancel	Creates canceled version of this event.
	Decline	Sets Status to Declined for participants with specified email. Removes all others from the event.
	Equals	Determines whether the specified object is equal to the current object. (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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetHeader	Gets header with specified key from this calendar entity. (Inherited from BasePdiEntity.)
	GetHeaders	Gets header with specified key from this calendar entity. (Inherited from BasePdiEntity.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InTimeZone	Specifies time zone for this event. Sets StartTimeZoneId and EndTimeZoneId. Remember to add the specified timezone to TimeZones.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RenderFinal	Renders this entity as a string. (Inherited from BasePdiEntity.)
	SetOrganizer	Sets organizer for this event.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Creates new version of this event that can be updated.

Top

Remarks

Copy

BEGIN:VEVENT
ORGANIZER;CN="Alice":MAILTO:alice@mail.com
ATTENDEE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE;CN='Bob':MAILTO:bob@mail.com
SUMMARY;LANGUAGE=en-US:First Meeting
DTSTART:20100315T080000
DTEND:20100315T083000
UID:040000008200E00074
CLASS:PUBLIC
DTSTAMP:20100317T141328Z
STATUS:CONFIRMED
LOCATION;LANGUAGE=en-US:Room 42
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:REMINDER
TRIGGER;RELATED=START:-PT15M
END:VALARM
END:VEVENT

Reference

Limilabs.Mail.Appointments Namespace

AppointmentEvents

AppointmentEvent

AppointmentAddEvent