EWSoftware.PDI Namespace Documentation
Observance
This class represents an observance rule component (STANDARD or DAYLIGHT) that can appear in a VTIMEZONE
calendar component.
Definition
Namespace: EWSoftware.PDI.Objects
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#
public class ObservanceRule : CalendarObjectVB
Public Class ObservanceRule
Inherits CalendarObjectC++
public ref class ObservanceRule : public CalendarObjectF#
type ObservanceRule =
class
inherit CalendarObject
end- Inheritance
- Object PDIObject CalendarObject ObservanceRule
Constructors
| ObservanceRule | Constructor |
| ObservanceRule(ObservanceRuleType) | Constructor |
Properties
| Comment | This is used to get the comment (COMMENT) property |
| CustomProperties | This is a catch-all that holds all unknown or extension properties |
| OffsetFrom | This is used to get the time zone Offset From (TZOFFSETFROM) property |
| OffsetTo | This is used to get the time zone Offset To (TZOFFSETTO) property |
| RecurDates | This is used to get the Recur Date (RDATE) properties. There may be more than one. |
| RecurrenceRules | This is used to get the Recurrence Rule (RRULE) properties. There may be more than one |
| RuleType | This is used to set or get the rule type |
| StartDateTime | This is used to get the start date/time (DTSTART) property |
| TimeZoneNames | This is used to get the Time Zone Name (TZNAME) properties. There may be more than one. |
| 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 PDIObjectVersionsSupported) |
Methods
| ApplyTimeZone |
The observance rule does not allow time zone IDs on its date/time objects
(Overrides CalendarObjectApplyTimeZone(VTimeZone)) |
| ClearProperties |
The method can be called to clear all current property values from the observance. The version and
rule type are left unchanged.
(Overrides CalendarObjectClearProperties) |
| 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 PDIObjectClone(PDIObject)) |
| Equals |
This is overridden to allow proper comparison of observance objects
(Overrides ObjectEquals(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 |
Get a hash code for the calendar object
(Overrides ObjectGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates 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 CalendarObjectPropagateVersion) |
| SetTimeZone |
The observance rule does not allow time zone IDs on its date/time objects
(Overrides CalendarObjectSetTimeZone(VTimeZone)) |
| TimeZonesUsed |
The observance rule does not allow time zone IDs on its date/time objects
(Overrides CalendarObjectTimeZonesUsed(StringCollection)) |
| ToString |
Convert the object instance to its string form
(Inherited from CalendarObject) |
| UpdateTimeZoneId |
The observance rule does not allow time zone IDs on its date/time objects
(Overrides CalendarObjectUpdateTimeZoneId(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 observance rule to a PDI data stream
(Overrides CalendarObjectWriteToStream(TextWriter, StringBuilder)) |