EWSoftware.PDI Namespace Documentation
Address
This class is used to represent the Address (ADR) property of a vCard. This specifies a structured
representation of the physical delivery address for the vCard 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 AddressProperty : BasePropertyVB
Public Class AddressProperty
Inherits BasePropertyC++
public ref class AddressProperty : public BasePropertyF#
type AddressProperty =
class
inherit BaseProperty
end- Inheritance
- Object PDIObject BaseProperty AddressProperty
Remarks
This property class parses the Value property and allows access to the component address parts. It is based on the X.500 Post Office Box attribute, the X.520 Street Address geographical attribute, the X.520 Locality Name geographical attribute, the X.520 State or Province Name geographical attribute, the X.520 Postal Code attribute, and the X.520 Country Name geographical attribute.
With the use of property grouping, the association can be limited to a group of properties.
Constructors
| AddressProperty | Constructor. Unless the version is changed, the object will conform to the vCard 3.0 specification. |
Properties
| AddressTypes | This property is used to set or get the address type flags |
| CharacterSet |
This is used to set or get the character set used for the value
(Inherited from BaseProperty) |
| Country | This property is used to set or get the country |
| 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 TEXT
(Overrides BasePropertyDefaultValueLocation) |
| EncodedValue |
This property is overridden to handle parsing the address components and concatenating them when
requested.
(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) |
| ExtendedAddress | This property is used to set or get the extended address |
| Geo | This property is used to get or set the geocoded location |
| Group |
The group to which this property belongs
(Inherited from BaseProperty) |
| Label | This property is used to get or set the label (the address in a format suitable for printing as an address label. |
| Language |
This is used to set or get the language used for the value
(Inherited from BaseProperty) |
| Locality | This property is used to set or get the locality (i.e. city) |
| POBox | This property is used to set or get the PO Box |
| PostalCode | This property is used to set or get the postal (zip) code |
| PreferredOrder | This property is used to get or set the preferred order (vCard 4.0 only) |
| PropertyId |
This is used to get or set the property ID for the value
(Inherited from BaseProperty) |
| Region | This property is used to set or get the region (i.e. state or province) |
| StreetAddress | This property is used to set or get the street address |
| Tag |
This read-only property defines the tag (ADR)
(Overrides BasePropertyTag) |
| TimeZone | This property is used to get or set the time zone associated with the address |
| Value |
This property is overridden to handle parsing the address components and concatenating them when
requested.
(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 |
This is overridden to provide custom handling of the TYPE 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 TYPE 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) |