VALARM Classes

The VAlarm class represents an alarm component in a VEVENT or a VTODO component. The VALARM component is used by iCalendar 2.0. In a vCalendar, the alarms are represented by four separate properties (AALARM, DALARM, MALARM, and PALARM). The VAlarm class is used to represent both the iCalendar sub-component and the vCalendar properties. It will write itself out in an appropriate format based on the current setting of its Version property. The ActionProperty is used to determine the actual alarm type.

PDI Tag

Component Property

EWSoftware PDI Class

Data Value Property

Notes

BEGIN:VALARM

 

VAlarm and VAlarmCollection

 

vCalendar represents this component as a property when written to a data stream.

ACTION

Action

ActionProperty

Action and OtherAction

 

ATTACH

Attachments

AttachProperty and AttachPropertyCollection

FormatType, GetAttachmentBytes, SetAttachmentBytes, and Value

If the value location is inline, the data value is a binary encoded string representing the attachment. If not inline, the Value property refers to something like a URI where the attachment can be found.

Only valid for audio, e-mail and procedure alarms. E-mail alarms can have multiple attachments but audio and procedure alarms can only have one.

ATTENDEE

Attendees

AttendeeProperty and AttendeePropertyCollection

CalendarUserType, CommonName, DelegatedFrom, DelegatedTo, DirectoryEntry, Expectation, Membership, ParticipationStatus, Role, Rsvp, SentBy, and Value

This property is only valid for e-mail alarms.

DESCRIPTION

Description

DescriptionProperty

AlternateRepresentation and Value

This property is only valid for display, e-mail, and procedure alarms.

DURATION

Duration

DurationProperty

DurationValue

 

REPEAT

Repeat

RepeatProperty

RepeatCount

 

SUMMARY

Summary

SummaryProperty

AlternateRepresentation and Value

This property is only valid for e-mail alarms.

TRIGGER

Trigger

TriggerProperty

DateTimeValue, DurationValue, IsFloating, RelatedToEnd, TimeZoneDateTime, and TimeZoneId

 

X-???

CustomProperties

CustomProperty and CustomPropertyCollection

CustomName and Value

This property class represents custom or extended properties that are not part of the specification.

END:VALARM

 

VAlarm and VAlarmCollection

 

vCalendar represents this component as a property when written to a data stream.

See Also