TriggerProperty Class

This class is used to represent the trigger (TRIGGER) property of an iCalendar VAlarm object.

Definition

Namespace: EWSoftware.PDI.Properties
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#View SourceRequest Example
public class TriggerProperty : BaseDateTimeProperty
Inheritance
Object    PDIObject    BaseProperty    BaseDateTimeProperty    TriggerProperty

Remarks

This property class parses the Value property to allow access to its content as an actual DateTime object or Duration object. The property value is a character string conforming to ISO 8601.

Constructors

TriggerProperty Default constructor

Properties

CalendarScale This is used to get or set the calendar scale (CALSCALE) parameter value
(Inherited from BaseDateTimeProperty)
CharacterSet This is used to set or get the character set used for the value
(Inherited from BaseProperty)
CustomParameters This property is used to set or get a string containing custom parameters that are not part of the specification. These are usually prefixed with "X-" to indicate an extension.
(Inherited from BaseProperty)
DateTimeValue This is overridden to set or get the date/time to use for the trigger expressed in local time. If set, the DurationValue will be ignored.
(Overrides BaseDateTimePropertyDateTimeValue)
DefaultValueLocation This read-only property defines the default value type as DURATION
(Overrides BasePropertyDefaultValueLocation)
DurationValue This property is used to set or get the duration to use for the trigger. If set, the DateTimeValue and TimeZoneDateTime properties will be ignored.
EncodedValue This property is overridden to handle converting the text value to a numeric value
(Overrides BaseDateTimePropertyEncodedValue)
EncodingMethod Set or get the encoding method for this property's value as a value in the EncodingType enumeration.
(Inherited from BaseProperty)
EncodingString Set or get the encoding method for this property's value as a string
(Inherited from BaseProperty)
Group The group to which this property belongs
(Inherited from BaseProperty)
IsFloating This is used to get or set whether or not the date/time is a floating value (assumed to be local time).
(Inherited from BaseDateTimeProperty)
Language This is used to set or get the language used for the value
(Inherited from BaseProperty)
PropertyId This is used to get or set the property ID for the value
(Inherited from BaseProperty)
RelatedToEnd This property is used to set or get the related (RELATED) parameter. If true, the trigger is related to the end time of the event. If false, the trigger is related to the start time of the event.
Tag This read-only property defines the tag (TRIGGER)
(Overrides BasePropertyTag)
TimeZoneDateTime This is overridden to set or get the date/time to use for the trigger expressed in the TimeZoneId time rather than local time on the current system. If set, the DurationValue will be ignored.
(Overrides BaseDateTimePropertyTimeZoneDateTime)
TimeZoneId This is used to get or set the time zone ID (TZID) parameter value
(Inherited from BaseDateTimeProperty)
UtcDateTime This is used to get or set the value as a DateTime object expressed in Universal Time.
(Inherited from BaseDateTimeProperty)
Value This property is overridden to handle converting the text value to a duration or date/time value
(Overrides BaseDateTimePropertyValue)
ValueLocation The value (data) type or location of this property's value
(Inherited from BaseProperty)
Version This is overridden to enforce the correct encoding type when the version changes
(Inherited from BaseProperty)
VersionsSupported This is used to establish the specification versions supported by the PDI object
(Overrides PDIObjectVersionsSupported)

Methods

Clone This is overridden to allow cloning of a PDI object
(Overrides PDIObjectClone)
Clone(PDIObject) This is overridden to allow copying of the additional properties
(Overrides BaseDateTimePropertyClone(PDIObject))
Decode This method is used to decode a value read in from a PDI data stream
(Inherited from BaseProperty)
DeserializeParameters This is overridden to provide custom handling of the RELATED parameter
(Overrides BaseDateTimePropertyDeserializeParameters(StringCollection))
Encode This method is used to encode a value for output to a PDI data stream
(Inherited from BaseProperty)
Equals This is overridden to allow proper comparison of property objects
(Inherited from BaseProperty)
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 property object
(Inherited from BaseProperty)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SerializeCharacterSet This is called to serialize the CHARSET parameter if necessary
(Inherited from BaseProperty)
SerializeCustomParameters This is called to serialize any custom parameters if necessary
(Inherited from BaseProperty)
SerializeEncoding This is called to serialize the ENCODING parameter if necessary
(Inherited from BaseProperty)
SerializeLanguage This is called to serialize the LANGUAGE parameter if necessary
(Inherited from BaseProperty)
SerializeParameters This is overridden to provide custom handling of the RELATED parameter
(Overrides BaseDateTimePropertySerializeParameters(StringBuilder))
SerializePropertyId This is called to serialize the PID parameter if necessary
(Inherited from BaseProperty)
SerializeValueLocation This is called to serialize the value location parameter if necessary
(Inherited from BaseProperty)
ToString This is overridden to convert the instance to a string
(Inherited from BaseProperty)
ToString(StringBuilder) This is used to convert the property instance to a format suitable for writing to a PDI data stream
(Inherited from BaseProperty)

See Also