Article
11/17/2011

OnSerializingAttribute Class

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

When applied to a method, specifies that the method is called before serialization of an object.

Inheritance Hierarchy

System.Object
System.Attribute
System.Runtime.Serialization.OnSerializingAttribute

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

Syntax

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

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

The OnSerializingAttribute type exposes the following members.

Constructors

	Name	Description
	OnSerializingAttribute	Initializes a new instance of the OnSerializingAttribute 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 OnSerializingAttribute class to manipulate the object before serialization occurs.

To use the OnSerializingAttributeclass, 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 of how to apply OnSerializingAttribute to a method.

\\ C#
[OnSerializingAttribute()]
internal void RunThisMethod(StreamingContext context)
{ 
    // Code not shown.
}

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

Note:
In your code, you can use the word OnSerializing instead of the longer OnSerializingAttribute.

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