Article
11/18/2011

OnDeserializingAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
System.Attribute
System.Runtime.Serialization.OnDeserializingAttribute

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Method, Inherited := False)> _
Public NotInheritable Class OnDeserializingAttribute _
    Inherits Attribute

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

The OnDeserializingAttribute type exposes the following members.

Constructors

	Name	Description
	OnDeserializingAttribute	Initializes a new instance of the OnDeserializingAttribute class.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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 OnDeserializingAttributeclass, 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#
[OnDeserializingAttribute()]
internal void RunThisMethod(StreamingContext context)
{ 
    // Code not shown.
}

' Visual Basic
<OnDeserializingAttribute()> _
Private Sub RunThisMethod(context As StreamingContext)
    ' Code not shown.
End Sub

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

Partager via