OnDeserializingAttribute Class

OnDeserializingAttribute Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

When applied to a method, specifies that the method is called during deserialization of an object.


Namespace:  System.Runtime.Serialization
Assembly:  mscorlib (in mscorlib.dll)

[AttributeUsageAttribute(AttributeTargets.Method, Inherited = false)]
public sealed class OnDeserializingAttribute : Attribute

The OnDeserializingAttribute type exposes the following members.

Public methodOnDeserializingAttributeInitializes a new instance of the OnDeserializingAttribute class.

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Use the OnDeserializingAttribute class to set default values during deserialization. For example, if the type that you are deserializing does not contain a constructor, create a method to set values of any fields in the instance and apply the attribute to the method.

To use the OnDeserializingAttribute, the method must contain a StreamingContext parameter. The attribute marks the method to be called by the serialization infrastructure, and the StreamingContext provides additional data about the type of serialization taking place. The following code shows an example how to apply OnDeserializingAttribute to a method.

\\ C#
internal void RunThisMethod(StreamingContext context)
    // Code not shown.

In your code, you can use the word OnDeserializing instead of the longer OnDeserializingAttribute.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

© 2017 Microsoft