ISerializable Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Allows an object to control its own serialization and deserialization through binary and XML serialization.
public interface class ISerializablepublic interface ISerializable[System.Runtime.InteropServices.ComVisible(true)]
public interface ISerializabletype ISerializable = interface[<System.Runtime.InteropServices.ComVisible(true)>]
type ISerializable = interfacePublic Interface ISerializable- Derived
- Attributes
Remarks
Any class that might be serialized using binary or XML serialization must be marked with the SerializableAttribute. If a class needs to control its binary or XML serialization process, it can implement the ISerializable interface. The Formatter calls the GetObjectData at serialization time and populates the supplied SerializationInfo with all the data required to represent the object. The Formatter creates a SerializationInfo with the type of the object in the graph. Objects that need to send proxies for themselves can use the FullTypeName and AssemblyName methods on SerializationInfo to change the transmitted information.
In the case of class inheritance, it is possible to serialize a class that derives from a base class that implements ISerializable. In this case, the derived class should call the base class implementation of GetObjectData inside its implementation of GetObjectData. Otherwise, the data from the base class will not be serialized.
The ISerializable interface implies a constructor with the signature constructor (SerializationInfo information, StreamingContext context). At deserialization time, the current constructor is called only after the data in the SerializationInfo has been deserialized by the formatter. In general, this constructor should be protected if the class is not sealed.
The order in which objects are deserialized cannot be guaranteed. For example, if one type references a type that has not been deserialized yet, an exception will occur. If you are creating types that have such dependencies, you can work around the problem by implementing the IDeserializationCallback interface and the OnDeserialization method.
The serialization architecture handles object types that extend MarshalByRefObject the same as types that extend Object. These types can be marked with the SerializableAttribute and implement the ISerializable interface as any other object type. Their object state will be captured and persisted onto the stream.
When these types are being used through System.Runtime.Remoting, the remoting infrastructure provides a surrogate that preempts typical serialization and instead serializes a proxy to the MarshalByRefObject. A surrogate is a helper that knows how to serialize and deserialize objects of a particular type. The proxy, invisible to the user in most cases, will be of type ObjRef.
As a general design pattern, it would be unusual for a class to be both marked with the serializable attribute and extend MarshalByRefObject. Developers should think carefully about the possible serialization and remoting scenarios when combining these two characteristics. One example where this might be applicable is with a MemoryStream. While the base class of MemoryStream (Stream) extends from MarshalByRefObject, it is possible to capture the state of a MemoryStream and restore it at will. It might, therefore, be meaningful to serialize the state of this stream into a database and restore it at some later point in time. However, when used through remoting, an object of this type would be proxied.
For more information about serialization of classes that extend MarshalByRefObject, see RemotingSurrogateSelector. For more information about implementing ISerializable, see Custom Serialization.
Note
This interface does not apply to JSON serialization using System.Text.Json.
Notes to Implementers
Implement this interface to allow an object to take part in its own serialization and deserialization.
Methods
| GetObjectData(SerializationInfo, StreamingContext) |
Obsolete.
Populates a SerializationInfo with the data needed to serialize the target object. |
