IDataContractSurrogate.GetDeserializedObject(Object, Type) Method

Reference

Definition

Namespace:: System.Runtime.Serialization

Assembly:: System.Runtime.Serialization.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

During deserialization, returns an object that is a substitute for the specified object.

public:
 System::Object ^ GetDeserializedObject(System::Object ^ obj, Type ^ targetType);

public object GetDeserializedObject(object obj, Type targetType);

abstract member GetDeserializedObject : obj * Type -> obj

Public Function GetDeserializedObject (obj As Object, targetType As Type) As Object

Parameters

obj: Object

The deserialized object to be substituted.

targetType: Type

The Type that the substituted object should be assigned to.

Returns

Object

The substituted deserialized object. This object must be of a type that is serializable by the DataContractSerializer. For example, it must be marked with the DataContractAttribute attribute or other mechanisms that the serializer recognizes.

Examples

The following example shows an implementation of the GetDeserializedObject method.

public object GetDeserializedObject(Object obj , Type targetType)
{
    Console.WriteLine("GetDeserializedObject invoked");
    // This method is called on deserialization.
    // If PersonSurrogated is being deserialized...
    if (obj is PersonSurrogated)
        {
            //... use the XmlSerializer to do the actual deserialization.
            PersonSurrogated ps = (PersonSurrogated)obj;
            XmlSerializer xs = new XmlSerializer(typeof(Person));
            return (Person)xs.Deserialize(new StringReader(ps.xmlData));
        }
        return obj;
}

Public Function GetDeserializedObject(ByVal obj As Object, _
    ByVal targetType As Type) As Object Implements _
    IDataContractSurrogate.GetDeserializedObject
    Console.WriteLine("GetDeserializedObject invoked")
    ' This method is called on deserialization.
    ' If PersonSurrogated is being deserialized...
    If TypeOf obj Is PersonSurrogated Then
        Console.WriteLine(vbTab & "returning PersonSurrogated")
        '... use the XmlSerializer to do the actual deserialization.
        Dim ps As PersonSurrogated = CType(obj, PersonSurrogated)
        Dim xs As New XmlSerializer(GetType(Person))
        Return CType(xs.Deserialize(New StringReader(ps.xmlData)), Person)
    End If
    Return obj

End Function

Remarks

In a simple implementation, use an if…then…else control structure to test whether the obj value is of the surrogated type. If so, transform it as necessary and return the substituted object. The substituted object can be a new instance or the same obj instance.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via