UniqueIdProperty Class

This class is used to represent the Unique Identifier property of an object (UID or X-IRMC-LUID)

Definition

Namespace: EWSoftware.PDI.Properties
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#View SourceRequest Example
public class UniqueIdProperty : BaseProperty
Inheritance
Object    PDIObject    BaseProperty    UniqueIdProperty

Remarks

This property has no special requirements or handling. If used, it should be a string of some sort that uniquely identifies the object. The Value property contains the unique ID string. A unique ID will be created automatically if the unique ID is requested and one does not already exist.

Constructors

UniqueIdProperty Default constructor

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 TEXT
(Overrides BasePropertyDefaultValueLocation)
EncodedValue This is overridden to create a unique ID if one does not already exist
(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. It returns UID for all specifications except IrMC 1.1 which uses X-IRMC-LUID.
(Overrides BasePropertyTag)
Value This is overridden to create a unique ID if one does not already exist
(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

AssignNewId This can be called to automatically create and assign a unique ID to the property
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 The 3.0 specification does not allow parameters. This will also be enforced for the 2.1 specification. 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)
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 The 3.0 specification does not allow parameters. This will also be enforced for the 2.1 specification. 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)

See Also