VAlarm Class

This class represents a VALARM component that can appear in a calendar

Definition

Namespace: EWSoftware.PDI.Objects
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2025.1.9.0
C#View SourceRequest Example
public class VAlarm : CalendarObject
Inheritance
Object    PDIObject    CalendarObject    VAlarm

Remarks

This object is written as a nested object for iCalendar 2.0. For vCalendar 1.0, it is written as a single property based on the type of alarm. The calendar object treats them as a collection of objects regardless of the specification version used.

Constructors

VAlarm Constructor. Unless the version is changed, the object will conform to the iCalendar 2.0 specification.

Properties

Action This is used to get the Action (ACTION) property. This is a required property and will always be set.
Attachments This is used to get the Attachment (ATTACH) properties. There may be more than one.
Attendees This is used to get the Attendee (ATTENDEE) properties. There may be more than one.
CustomProperties This is a catch-all that holds all unknown or extension properties
Description This is used to get the description (DESCRIPTION) property
Duration This is used to get the Duration (DURATION) property
Repeat This is used to get the Repeat (REPEAT) property
Summary This is used to get the summary (SUMMARY) property
Trigger This is used to get the Trigger (TRIGGER) property. This is a required property and will always be set.
Version This is overridden to propagate the version to all properties in the object that need it when the version is set on the item.
(Inherited from CalendarObject)
VersionsSupported This is used to establish the specification versions supported by the PDI object
(Overrides PDIObject.VersionsSupported)

Methods

ApplyTimeZone This is used to apply the selected time zone to all date/time objects in the component and convert them to the new time zone.
(Overrides CalendarObject.ApplyTimeZone(VTimeZone))
ClearProperties The method can be called to clear all current property values from the alarm. The version is left unchanged.
(Overrides CalendarObject.ClearProperties())
Clone() This is overridden to allow cloning of a PDI object
(Overrides PDIObject.Clone())
Clone(PDIObject) This is overridden to allow copying of the additional properties
(Overrides PDIObject.Clone(PDIObject))
Equals This is overridden to allow proper comparison of alarm objects
(Overrides Object.Equals(Object))
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Get a hash code for the calendar object
(Overrides Object.GetHashCode())
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
PropagateVersion This is used to propagate the version to all properties in the object that need it
(Overrides CalendarObject.PropagateVersion())
SetTimeZone This is used to set the selected time zone in all date/time objects in the component without modifying the date/time values.
(Overrides CalendarObject.SetTimeZone(VTimeZone))
TimeZonesUsed This is used to get a list of time zones used by all owned objects
(Overrides CalendarObject.TimeZonesUsed(StringCollection))
ToString Convert the object instance to its string form
(Inherited from CalendarObject)
UpdateTimeZoneId This is used to replace an old time zone ID with a new time zone ID in all properties of a calendar object.
(Overrides CalendarObject.UpdateTimeZoneId(String, String))
WriteToStream(TextWriter) This can be used to write a calendar object to a PDI data stream
(Inherited from CalendarObject)
WriteToStream(TextWriter, StringBuilder) This can be used to write an alarm to a PDI data stream
(Overrides CalendarObject.WriteToStream(TextWriter, StringBuilder))

See Also