OnSerializingAttribute Class

OnSerializingAttribute 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 before serialization of an object.


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

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

The OnSerializingAttribute type exposes the following members.

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

To use the OnSerializingAttribute, 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#
internal void RunThisMethod(StreamingContext context)
    // Code not shown.

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

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.

© 2016 Microsoft