Export (0) Print
Expand All

DataContractResolver Class

.NET Framework 4.6 and 4.5

Provides a mechanism for dynamically mapping types to and from xsi:type representations during serialization and deserialization.

System.Object
  System.Runtime.Serialization.DataContractResolver
    System.Data.Objects.ProxyDataContractResolver

Namespace:  System.Runtime.Serialization
Assemblies:   System.Runtime.Serialization (in System.Runtime.Serialization.dll)
  System.Runtime.Serialization.Xml (in System.Runtime.Serialization.Xml.dll)

public abstract class DataContractResolver

The DataContractResolver type exposes the following members.

  NameDescription
Protected methodDataContractResolverInitializes a new instance of the DataContractResolver class.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodResolveNameOverride this method to map the specified xsi:type name and namespace to a data contract type during deserialization.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTryResolveTypeOverride this method to map a data contract type to an xsi:type name and namespace during serialization.
Top

Developers should be careful about what data is being sent over the wire. You can use transport or message security to secure that data. For more information, see see Security in WCF.

Caution noteCaution

Only use DataContractResolver if you are completely sure of what information is being serialized. Malicious types can cause unexpected behavior.

The following example shows how to derive a class from DataContractResolver. For a working sample, see DataContractResolver.

class MyDataContractResolver : DataContractResolver
{
    private Dictionary<string, XmlDictionaryString> dictionary = new Dictionary<string, XmlDictionaryString>();
    Assembly assembly;

    // Definition of the DataContractResolver 
    public MyDataContractResolver(Assembly assembly)
    {
        this.assembly = assembly;
    }

    // Used at deserialization 
    // Allows users to map xsi:type name to any Type  
    public override Type ResolveName(string typeName, string typeNamespace, Type declaredType, DataContractResolver knownTypeResolver)
    {
        XmlDictionaryString tName;
        XmlDictionaryString tNamespace;
        if (dictionary.TryGetValue(typeName, out tName) && dictionary.TryGetValue(typeNamespace, out tNamespace))
        {
            return this.assembly.GetType(tNamespace.Value + "." + tName.Value);
        }
        else
        {
            return null;
        }
    }
    // Used at serialization 
    // Maps any Type to a new xsi:type representation 
    public override bool TryResolveType(Type type, Type declaredType, DataContractResolver knownTypeResolver, out XmlDictionaryString typeName, out XmlDictionaryString typeNamespace)
    {
        string name = type.Name;
        string namesp = type.Namespace;
        typeName = new XmlDictionaryString(XmlDictionary.Empty, name, 0); 
        typeNamespace = new XmlDictionaryString(XmlDictionary.Empty, namesp, 0);
        if (!dictionary.ContainsKey(type.Name))
        {
            dictionary.Add(name, typeName);
        }
        if (!dictionary.ContainsKey(type.Namespace))
        {
            dictionary.Add(namesp, typeNamespace);
        }
        return true;
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft