CategoriesProperty Class

This class is used to represent the Categories (CATEGORIES) property of a vCard, vCalendar, or iCalendar object.

Definition

Namespace: EWSoftware.PDI.Properties
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
public class CategoriesProperty : BaseProperty
Inheritance
Object    PDIObject    BaseProperty    CategoriesProperty

Remarks

This property class parses the Value property and allows access to the component parts. It is used to specify application category information about the object. This property is only valid for use with the vCard 3.0 specification, vNote, vCalendar and iCalendar objects.

Constructors

CategoriesProperty Constructor. Unless the version is changed, the object will conform to the vCard 3.0/iCalendar 2.0 specification.

Properties

Categories This property is used to get the categories string collection
CategoriesString This property is used to set or get the categories as a string 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)
DefaultValueLocation This read-only property defines the default value type as TEXT
(Overrides BasePropertyDefaultValueLocation)
EncodedValue This property is overridden to handle parsing the categories 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)
Group The group to which this property belongs
(Inherited from BaseProperty)
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 defines the tag (CATEGORIES)
(Overrides BasePropertyTag)
Value This property is overridden to handle parsing the categories 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 values from the specified PDI object into the instance
(Inherited from BaseProperty)
Decode This method is used to decode a value read in from a PDI data stream
(Inherited from BaseProperty)
DeserializeParameters This is used to deserialize parameter values from a string collection
(Inherited from BaseProperty)
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 method can be overridden to customize how the parameters are appended to the property when being serialized to a PDI data stream.
(Inherited from BaseProperty)
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