AlarmTrigger Property
This property contains the time when the alarm is triggered.
Syntax
__property String AlarmTrigger[int AlarmIndex] = {read=FAlarmTrigger, write=FSetAlarmTrigger};
Default Value
""
Remarks
This property contains the time when the alarm is triggered.
The AlarmTrigger is represented as a duration relative to the start of an event. The format is (+/-)P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:
| P | is the duration designator (historically called "period") placed at the start of the duration representation. |
| W | is the week designator that follows the value for the number of weeks. |
| D | is the day designator that follows the value for the number of days. |
| T | is the time designator that precedes the time components of the representation. |
| H | is the hour designator that follows the value for the number of hours. |
| M | is the minute designator that follows the value for the number of minutes. |
| S | is the second designator that follows the value for the number of seconds. |
Either a positive or negative duration may be specified for the
AlarmTrigger property. An alarm with a positive duration is
triggered after the associated start of the event (or to-do).
An alarm with a negative duration is triggered before the
start of the event.
For instance, the following code instructs an alarm to fire 10 minutes before the event starts:
CalDAV.Alarm.Trigger = "-PT10M"The size of the array is controlled by the AlarmCount property.
This property is not available at design time.
Data Type
String