BasePropertyDeserializeParameters Method

This is used to deserialize parameter values from a string collection

Definition

Namespace: EWSoftware.PDI.Properties
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
public virtual void DeserializeParameters(
	StringCollection parameters
)

Parameters

parameters  StringCollection
The parameters for the property

Remarks

The base class will extract and set the value of the following parameters. Unless a derived class wants to handle them itself, they can be ignored and this base class version called to process them. Any parameters that are handled should be removed from the collection so that they do not end up in the custom parameters property if the base class does not recognize them.

Depending on the object for which data is being parsed, there may be a mixture of name/value pairs or values alone in the parameters string collection. It is up to the derived class to process the parameter list based on the specification to which it conforms. For entries that are parameter names, the entry will end with an equals sign (=) and the entry immediately following it in the collection is its associated parameter value. Entries that do not end in an equals sign are assumed to be values alone. The property name, parameter names, and their values may be in upper, lower, or mixed case.

The default parameters handled include:

ParameterDescription
EncodingThe encoding type used on the property value
Character SetThe character set for the property value
LanguageThe language used for the value
Value (Location)The location/data type of the property value
Property ID (PID)The property ID for the property used to match properties across instances
Custom parametersAny unrecognized parameters will be stored as a string of custom parameters. If a derived class handles a parameter, it should remove it from the collection.

See Also