EWSoftware.PDI Namespace Documentation
Base
This class is used as a base class for the various date/time properties
Definition
Namespace: EWSoftware.PDI.Properties
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 abstract class BaseDateTimeProperty : BasePropertyVB
Public MustInherit Class BaseDateTimeProperty
Inherits BasePropertyC++
public ref class BaseDateTimeProperty abstract : public BasePropertyF#
[<AbstractClassAttribute>]
type BaseDateTimeProperty =
class
inherit BaseProperty
end- Inheritance
- Object PDIObject BaseProperty BaseDateTimeProperty
- Derived
Remarks
This property class parses the Value property to allow access to its
content as an actual DateTime object. The time zone ID property (TZID) can also be
set or retrieved (iCalendar only).
Constructors
| BaseDateTimeProperty | Constructor |
Properties
| CalendarScale | This is used to get or set the calendar scale (CALSCALE) parameter value |
| 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 used to get or set the value as a DateTime object expressed in local time. |
| DefaultValueLocation |
Derived classes should override this to define the default data type/location to use if a VALUE
parameter is not specified.
(Inherited from BaseProperty) |
| EncodedValue |
This property is overridden to handle parsing the date/time to/from its string form
(Overrides BasePropertyEncodedValue) |
| 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). |
| 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) |
| Tag |
This read-only property must be specified to define the tag used for the property (i.e. FN, N, ADR,
etc).
(Inherited from BaseProperty) |
| TimeZoneDateTime | This is used to get or set the value as a DateTime object expressed in the specified TimeZoneId rather than local time on the current system. |
| TimeZoneId | This is used to get or set the time zone ID (TZID) parameter value |
| UtcDateTime | This is used to get or set the value as a DateTime object expressed in Universal Time. |
| Value |
This property is overridden to handle parsing the date/time to/from its string form
(Overrides BasePropertyValue) |
| 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 |
All objects derived from this class must implement this to indicate the specification versions with
which they can be used.
(Inherited from PDIObject) |
Methods
| Clone |
This must be overridden to allow cloning of a PDI object
(Inherited from PDIObject) |
| Clone(PDIObject) |
This is overridden to allow copying of the additional properties
(Overrides BasePropertyClone(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 TZID parameter
(Overrides BasePropertyDeserializeParameters(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) |
| 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 property object
(Inherited from BaseProperty) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates 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 TZID parameter
(Overrides BasePropertySerializeParameters(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) |