EWSoftware.PDI Namespace Documentation
Geographic
This class is used to represent the geographic position (GEO) property of a vCard or vCalendar object
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 class GeographicPositionProperty : BasePropertyVB
Public Class GeographicPositionProperty
Inherits BasePropertyC++
public ref class GeographicPositionProperty : public BasePropertyF#
type GeographicPositionProperty =
class
inherit BaseProperty
end- Inheritance
- Object PDIObject BaseProperty GeographicPositionProperty
Remarks
This property class parses the Value property to allow access to its individual latitude and longitude parts as numeric values.
For the vCard 2.1 and vCalendar 1.0 specification, the values are separated by a comma. For the vCard 3.0 and iCalendar 2.0 specification, they are separated by a semi-colon.
Constructors
| GeographicPositionProperty | Constructor. Unless the version is changed, the object will conform to the vCard 3.0/iCalendar 2.0 specification. |
Properties
| 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) |
| DefaultValueLocation |
This read-only property defines the default value type as FLOAT
(Overrides BasePropertyDefaultValueLocation) |
| EncodedValue |
This property is overridden to handle parsing the component parts to/from their 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) |
| IncludeGeoUriPrefix | This is used to get or set whether or not to include the "geo:" URI prefix when saving the property value in vCard 4.0 files. |
| Language |
This is used to set or get the language used for the value
(Inherited from BaseProperty) |
| Latitude | This is used to get or set the latitude as a floating point value |
| Longitude | This is used to get or set the longitude as a floating point value |
| PropertyId |
This is used to get or set the property ID for the value
(Inherited from BaseProperty) |
| Tag |
This read-only property defines the tag (GEO)
(Overrides BasePropertyTag) |
| Value |
This property is overridden to handle parsing the component parts to/from their 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 |
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 BasePropertyClone(PDIObject)) |
| Decode |
This method is used to decode a value read in from a PDI data stream
(Inherited from BaseProperty) |
| DeserializeParameters |
The specifications do not allow parameters for this property. Any parameters are ignored.
(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 |
The specifications do not allow parameters for this property. Any parameters are ignored.
(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) |